NXOpen .NET Reference
12.0.0
|
Builder used to model a piece of Off Sheet Connector. More...
Public Types | |
enum | StyleOption { SmallFilledArrowOut, SmallFilledArrowIn, Box, ChevronOut, ChevronIn } |
the style of OSC elements. More... | |
Public Member Functions | |
unsafe void | Rotate () |
To rotate a off sheet connector More... | |
unsafe void | FlipHorizontally () |
To flip a off sheet connector horizonally More... | |
unsafe void | FlipVertically () |
To flip a off sheet connector vertically More... | |
unsafe NXOpen.Point2d | GetLocation () |
Gets the symbol location. More... | |
unsafe void | SetLocation (NXOpen.Point2d location) |
Sets the symbol location. More... | |
unsafe void | SetConnection (NXOpen.PID.ConnectionEndType type, NXOpen.PID.Pipe connection, string connectionId) |
To set the connection connecting to the OSC sheet element. More... | |
unsafe void | GetConnection (out NXOpen.PID.ConnectionEndType type, out NXOpen.PID.Pipe connection, out string connectionId) |
To get the connection connecting to the OSC sheet element. More... | |
unsafe void | LinkOSC (NXOpen.PID.OffSheetConnector desObject) |
Links to the destination OSC. More... | |
unsafe NXOpen.Diagramming.Node | GetNode () |
Get the node object of the off sheet connector builder. 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 string | ElementId [get, set] |
Returns or sets the current element ID of this OSC. More... | |
unsafe bool | Horizontal [get] |
Returns the option to flip the symbol horizontally. More... | |
unsafe NXOpen.PID.Sheet | OwningSheet [get, set] |
Returns or sets the owning sheet of this sheet element. More... | |
unsafe NXOpen.PID.RotateAngleOption | RotateOption [get, set] |
Returns or sets the symbol rotation angle. More... | |
unsafe NXOpen.PID.OffSheetConnectorBuilder.StyleOption | Style [get, set] |
Returns or sets the style of OSC More... | |
unsafe NXOpen.Diagramming.TextStyleBuilder | TextStyleBuilder [get] |
Returns the text style of the OSC. More... | |
unsafe bool | Vertical [get] |
Returns the option to flip the symbol vertically. More... | |
Builder used to model a piece of Off Sheet Connector.
To create a new instance of this class, use NXOpen.PID.PidManager.CreateOffSheetConnectorBuilder
Default values.
Property | Value |
---|---|
RotateOption |
Zero |
Created in NX11.0.1
unsafe void NXOpen.PID.OffSheetConnectorBuilder.FlipHorizontally | ( | ) |
To flip a off sheet connector horizonally
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
unsafe void NXOpen.PID.OffSheetConnectorBuilder.FlipVertically | ( | ) |
To flip a off sheet connector vertically
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
unsafe void NXOpen.PID.OffSheetConnectorBuilder.GetConnection | ( | out NXOpen.PID.ConnectionEndType | type, |
out NXOpen.PID.Pipe | connection, | ||
out string | connectionId | ||
) |
To get the connection connecting to the OSC sheet element.
Created in NX11.0.1
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
type | |
connection | |
connectionId |
unsafe NXOpen.Point2d NXOpen.PID.OffSheetConnectorBuilder.GetLocation | ( | ) |
Gets the symbol location.
Created in NX11.0.1
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
unsafe NXOpen.Diagramming.Node NXOpen.PID.OffSheetConnectorBuilder.GetNode | ( | ) |
Get the node object of the off sheet connector builder.
Created in NX12.0.0
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
unsafe void NXOpen.PID.OffSheetConnectorBuilder.LinkOSC | ( | NXOpen.PID.OffSheetConnector | desObject | ) |
Links to the destination OSC.
If the input OffSheetConnector is NULL, it means break the existing link.
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
desObject |
unsafe void NXOpen.PID.OffSheetConnectorBuilder.Rotate | ( | ) |
To rotate a off sheet connector
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
unsafe void NXOpen.PID.OffSheetConnectorBuilder.SetConnection | ( | NXOpen.PID.ConnectionEndType | type, |
NXOpen.PID.Pipe | connection, | ||
string | connectionId | ||
) |
To set the connection connecting to the OSC sheet element.
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
type | |
connection | |
connectionId |
unsafe void NXOpen.PID.OffSheetConnectorBuilder.SetLocation | ( | NXOpen.Point2d | location | ) |
Sets the symbol location.
Created in NX11.0.1
License requirements: nx_pid_design_author ("NX P and ID Design Author")
location | the osc location. |
|
getset |
Returns or sets the current element ID of this OSC.
It works only in edit mode, it's optional and the first element ID stored in the OSC will be used as default.
Created in NX11.0.1
License requirements to get this property: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")
|
get |
Returns the option to flip the symbol horizontally.
Created in NX11.0.1
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
|
getset |
Returns or sets the owning sheet of this sheet element.
Its setting method works only in creation mode.
Created in NX11.0.1
License requirements to get this property: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")
|
getset |
Returns or sets the symbol rotation angle.
Created in NX11.0.1
License requirements to get this property: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")
|
getset |
Returns or sets the style of OSC
Created in NX11.0.1
License requirements to get this property: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")
|
get |
Returns the text style of the OSC.
Created in NX11.0.1
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
|
get |
Returns the option to flip the symbol vertically.
Created in NX11.0.1
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")