NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Diagramming.LocationBuilder Class Reference

Represents a LocationBuilder. More...

Inheritance diagram for NXOpen.Diagramming.LocationBuilder:
NXOpen.Diagramming.BaseSubObjectBuilder NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Diagramming.ConnectionLocationBuilder

Public Member Functions

unsafe void SetValueX (double inputPercent, double inputValue)
 Set the x value of the location. More...
 
unsafe void SetValueY (double inputPercent, double inputValue)
 Set the y value of the location. More...
 
- Public Member Functions inherited from NXOpen.Diagramming.BaseSubObjectBuilder
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe double EvaluatedValueX [get]
 Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset. More...
 
unsafe double EvaluatedValueY [get]
 Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset. More...
 
unsafe double InputPercentX [get, set]
 Returns or sets the user input percentage (0. More...
 
unsafe double InputPercentY [get, set]
 Returns or sets the user input percentage (0. More...
 
unsafe double InputValueX [get, set]
 Returns or sets the user input X coordinate. More...
 
unsafe double InputValueY [get, set]
 Returns or sets the user input Y coordinate. More...
 
unsafe
NXOpen.Diagramming.SheetElement 
Reference [get, set]
 Returns or sets the sheet element whose coordinate system the coordinate is specified in. More...
 
unsafe bool UpToDate [get]
 Returns the up to date flag. More...
 

Detailed Description

Represents a LocationBuilder.

This is a sub-builder class and cannot be directly instantiated

Created in NX10.0.0

Member Function Documentation

unsafe void NXOpen.Diagramming.LocationBuilder.SetValueX ( double  inputPercent,
double  inputValue 
)

Set the x value of the location.

The inputPercent means of the x coordinate value as a percentage of the size of its reference object. The valid value is from 0.0 to 1.0, and 1.0 means 100%. The inputValue means the offset value of the x coordinate from the calculated location by the inputPercent value.

Created in NX10.0.0

License requirements: None.

Parameters
inputPercent
inputValue
unsafe void NXOpen.Diagramming.LocationBuilder.SetValueY ( double  inputPercent,
double  inputValue 
)

Set the y value of the location.

The inputPercent means of the y coordinate value as a percentage of the size of its reference object. The valid value is from 0.0 to 1.0, and 1.0 means 100%. The inputValue means the offset value of the y coordinate from the calculated location by the inputPercent value.

Created in NX10.0.0

License requirements: None.

Parameters
inputPercent
inputValue

Property Documentation

unsafe double NXOpen.Diagramming.LocationBuilder.EvaluatedValueX
get

Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset.

Created in NX10.0.0

License requirements: None.

unsafe double NXOpen.Diagramming.LocationBuilder.EvaluatedValueY
get

Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset.

Created in NX10.0.0

License requirements: None.

unsafe double NXOpen.Diagramming.LocationBuilder.InputPercentX
getset

Returns or sets the user input percentage (0.

0 to 1.0) of the width of the referenced object.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.LocationBuilder.InputPercentY
getset

Returns or sets the user input percentage (0.

0 to 1.0) of the height of the referenced object.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.LocationBuilder.InputValueX
getset

Returns or sets the user input X coordinate.

If the location refers to an object, the input X is the offset to the X coordinate of the object; Otherwise, it's the X coordinate value.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.LocationBuilder.InputValueY
getset

Returns or sets the user input Y coordinate.

If the location refers to an object, the input Y is the offset to the Y coordinate of the object; Otherwise, it's the Y coordinate value.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetElement NXOpen.Diagramming.LocationBuilder.Reference
getset

Returns or sets the sheet element whose coordinate system the coordinate is specified in.

If this is a null reference (Nothing in Visual Basic), the coordinate is in the Sheet's coordinate system.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.LocationBuilder.UpToDate
get

Returns the up to date flag.

If true, NXOpen.Diagramming.LocationBuilder.EvaluatedValueX and NXOpen.Diagramming.LocationBuilder.EvaluatedValueY of NXOpen.Diagramming.LocationBuilder may be used; Otherwise it must be evaluated.

Created in NX10.0.0

License requirements: None.


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