NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.AME.SymbolAuthoringBuilder Class Reference

Represents a Symbol Authoring class Builder More...

Inheritance diagram for NXOpen.AME.SymbolAuthoringBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  Types { StandardSymbol, CableDefinitionLine }
 Represents the type of symbol More...
 

Public Member Functions

unsafe
NXOpen.Annotations.CustomSymbol 
InsertSymbol (string customSymbolPath)
 Insert the symbol More...
 
unsafe NXOpen.NXObject CreateConnectionPoint (NXOpen.NXObject portToBeMapped)
 Creates a new connection point More...
 
unsafe NXOpen.Point2d GetConnectionPointLocation (NXOpen.NXObject libPort)
 Gets the connection point location More...
 
unsafe NXOpen.Point2d SetConnectionPointLocation (NXOpen.NXObject libPort)
 Sets the connection point location More...
 
unsafe NXOpen.Point2d GetConnectionDirection (NXOpen.NXObject libPort)
 Gets the connection direction More...
 
unsafe NXOpen.Point2d SetConnectionDirection (NXOpen.NXObject libPort)
 Sets the connection direction More...
 
unsafe void DeleteConnectionPoint (NXOpen.NXObject portToBeUnmapped, NXOpen.NXObject libPort)
 Deletes the connection point More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe NXOpen.Point2d AnchorPointLocation [get, set]
 Returns or sets the symbol anchor point More...
 
unsafe
NXOpen.Gateway.ImageCaptureBuilder 
CapturedImage [get]
 Returns the image capture builder used to create an image for preview More...
 
unsafe
NXOpen.Tooling.SelectReuseLibraryItemBuilder 
SelectedCustomSymbol [get]
 Returns the custom symbol selection More...
 
unsafe NXOpen.AME.SelectAMEPort SelectedPort [get]
 Returns the port selection More...
 
unsafe NXOpen.Point2d SymbolAnnotationPoint [get]
 Returns the symbol annotation point More...
 
unsafe
NXOpen.AME.SymbolAuthoringBuilder.Types 
Type [get, set]
 Returns or sets the symbol type More...
 

Detailed Description

Represents a Symbol Authoring class Builder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateSymbolAuthoringBuilder

Default values.

Property Value

CapturedImage.CaptureMethod

GraphicsArea

CapturedImage.Format

Bmp

CapturedImage.Size

Pixels64

Type

StandardSymbol

Created in NX12.0.0

Member Enumeration Documentation

Represents the type of symbol

Enumerator
StandardSymbol 
CableDefinitionLine 

Member Function Documentation

unsafe NXOpen.NXObject NXOpen.AME.SymbolAuthoringBuilder.CreateConnectionPoint ( NXOpen.NXObject  portToBeMapped)

Creates a new connection point

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portToBeMapped
Returns
unsafe void NXOpen.AME.SymbolAuthoringBuilder.DeleteConnectionPoint ( NXOpen.NXObject  portToBeUnmapped,
NXOpen.NXObject  libPort 
)

Deletes the connection point

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portToBeUnmapped
libPort
unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.GetConnectionDirection ( NXOpen.NXObject  libPort)

Gets the connection direction

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libPort
Returns
unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.GetConnectionPointLocation ( NXOpen.NXObject  libPort)

Gets the connection point location

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libPort
Returns
unsafe NXOpen.Annotations.CustomSymbol NXOpen.AME.SymbolAuthoringBuilder.InsertSymbol ( string  customSymbolPath)

Insert the symbol

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
customSymbolPath
Returns
unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.SetConnectionDirection ( NXOpen.NXObject  libPort)

Sets the connection direction

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libPort
Returns
unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.SetConnectionPointLocation ( NXOpen.NXObject  libPort)

Sets the connection point location

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libPort
Returns

Property Documentation

unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.AnchorPointLocation
getset

Returns or sets the symbol anchor point

Created in NX12.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.Gateway.ImageCaptureBuilder NXOpen.AME.SymbolAuthoringBuilder.CapturedImage
get

Returns the image capture builder used to create an image for preview

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.Tooling.SelectReuseLibraryItemBuilder NXOpen.AME.SymbolAuthoringBuilder.SelectedCustomSymbol
get

Returns the custom symbol selection

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectAMEPort NXOpen.AME.SymbolAuthoringBuilder.SelectedPort
get

Returns the port selection

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.Point2d NXOpen.AME.SymbolAuthoringBuilder.SymbolAnnotationPoint
get

Returns the symbol annotation point

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SymbolAuthoringBuilder.Types NXOpen.AME.SymbolAuthoringBuilder.Type
getset

Returns or sets the symbol type

Created in NX12.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")


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