NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Diagramming.ReferenceGeometryBuilder Class Reference

This builder is used to create/edit Reference Geometry More...

Inheritance diagram for NXOpen.Diagramming.ReferenceGeometryBuilder:
NXOpen.Diagramming.AnnotationBuilder NXOpen.IExternalFileReferencer NXOpen.Diagramming.ConnectableElementBuilder NXOpen.Diagramming.SheetElementBuilder NXOpen.Diagramming.BaseObjectBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe
NXOpen.ExternalFileReferenceAdapter 
EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
 Establish the external reference to the given file specification. More...
 
unsafe double[] GetColor ()
 Gets the color More...
 
unsafe string GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
 Gets the file definition to use for external file adapter. More...
 
unsafe
NXOpen.ExternalFileReferenceAdapter 
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
unsafe void RefreshFromView (bool refresh)
 When set will cause a refresh of the geometry from the drawing view during commit. More...
 
unsafe void SetColor (double[] color)
 Sets the color More...
 
unsafe void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
 Sets the external file reference object. More...
 

Properties

unsafe bool DisplayBorder [get, set]
 Returns or sets the setting that determines whether the border should be displayed or not. More...
 
unsafe double Scale [get, set]
 Returns or sets the scale More...
 
unsafe int Transparency [get, set]
 Returns or sets the transparency (between 0 and 100) More...
 
unsafe string View [get, set]
 Returns or sets the view to import from More...
 
- Properties inherited from NXOpen.Diagramming.AnnotationBuilder
unsafe bool BoundaryDisplay [get, set]
 Returns or sets the visibility of boundary. More...
 
unsafe
NXOpen.Diagramming.DiagrammingAnnotationboundarytype 
BoundaryType [get, set]
 Returns or sets the boundary type of the annotation More...
 
unsafe
NXOpen.Diagramming.FormattedStringBuilder 
FormattedStringBuilder [get]
 Returns the formatted string of the text. More...
 
unsafe string Text [get, set]
 Returns or sets the text should be used only when textType is Diagramming. More...
 
unsafe
NXOpen.Diagramming.TextStyleBuilder 
TextStyleBuilder [get]
 Returns the text style of the annotation. More...
 
unsafe
NXOpen.Diagramming.AnnotationBuilder.TextTypeOption 
TextType [get, set]
 Returns or sets the text type. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.Diagramming.AnnotationBuilder
enum  TextTypeOption { Fixed, Parametric }
 Represents the option NXOpen.Diagramming.AnnotationBuilder.TextType for a NXOpen.Diagramming.AnnotationBuilder . More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

This builder is used to create/edit Reference Geometry

To create a new instance of this class, use NXOpen.Diagramming.SmartDiagrammingManager.CreateReferenceGeometryBuilder

Created in NX1847.0.0

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Diagramming.ReferenceGeometryBuilder.EstablishReference ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter.Type  referenceType,
string  externalFileSpec 
)
inline

Establish the external reference to the given file specification.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe double [] NXOpen.Diagramming.ReferenceGeometryBuilder.GetColor ( )
inline

Gets the color

Created in NX1847.0.0

License requirements: None.

Returns
Array of 3 RGB values, each between 0 and 1
unsafe string NXOpen.Diagramming.ReferenceGeometryBuilder.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter  adapter)
inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters
adapterexternal file reference object
Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Diagramming.ReferenceGeometryBuilder.GetExternalFileReferenceAdapter ( int  referenceObjectId)
inline

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe void NXOpen.Diagramming.ReferenceGeometryBuilder.RefreshFromView ( bool  refresh)
inline

When set will cause a refresh of the geometry from the drawing view during commit.

Created in NX1847.0.0

License requirements: None.

Parameters
refreshtrue - a refresh will be performed, false - a refresh will not be performed
unsafe void NXOpen.Diagramming.ReferenceGeometryBuilder.SetColor ( double[]  color)
inline

Sets the color

Created in NX1847.0.0

License requirements: None.

Parameters
colorArray of 3 RGB values, each between 0 and 1
unsafe void NXOpen.Diagramming.ReferenceGeometryBuilder.SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter  adapter 
)
inline

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.

Created in NX1847.0.0

License requirements: None.

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implements NXOpen.IExternalFileReferencer.

Property Documentation

unsafe bool NXOpen.Diagramming.ReferenceGeometryBuilder.DisplayBorder
getset

Returns or sets the setting that determines whether the border should be displayed or not.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.ReferenceGeometryBuilder.Scale
getset

Returns or sets the scale

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Diagramming.ReferenceGeometryBuilder.Transparency
getset

Returns or sets the transparency (between 0 and 100)

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Diagramming.ReferenceGeometryBuilder.View
getset

Returns or sets the view to import from

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.