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

Represents a SheetElementBuilder. More...

Inheritance diagram for NXOpen.Diagramming.SheetElementBuilder:
NXOpen.Diagramming.BaseObjectBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.Diagramming.ConnectableElementBuilder NXOpen.Diagramming.ConnectionBuilder NXOpen.Diagramming.GroupBuilder NXOpen.Diagramming.LeaderLineBuilder NXOpen.Diagramming.PortBuilder NXOpen.Diagramming.ShapeBuilder NXOpen.Diagramming.AnnotationBuilder NXOpen.Diagramming.NodeBuilder NXOpen.Diagramming.ReferenceGeometryBuilder NXOpen.Diagramming.Tables.TableBuilder

Public Types

enum  ResizeOptionType {
  AnyDirection, OnAnchor, SameRatio, SameRationOnCorner,
  SameRatioOnEdge
}
 Represents the resize option for a NXOpen.Diagramming.SheetElementBuilder . More...
 

Public Member Functions

unsafe void GetAllowedTransformations (out bool isAllowedTranslation, out bool isAllowedRotation, out bool isAllowedScale, out bool isAllowedShear)
 Get the allowed transformations of the sheet element. More...
 
unsafe void GetMinNodeSize (out double[] sizeValues)
 Gets the minimum node size values More...
 
unsafe void SetMinNodeSize (double[] sizeValues)
 Sets the minimum node size values More...
 
unsafe void SetOwningSheet (NXOpen.Diagramming.Sheet owningSheet)
 Set the owning sheet when the sheet element is created. More...
 

Properties

unsafe double Height [get, set]
 Returns or sets the height. More...
 
unsafe
NXOpen.Diagramming.DiagrammingSizingpolicy 
HeightPolicy [get, set]
 Returns or sets the height policy. More...
 
unsafe bool Internal [get]
 Returns the flag that indicates if the sheet element is internal. More...
 
unsafe
NXOpen.Diagramming.Annotation 
Label [get]
 Returns the label of this sheet element. More...
 
unsafe string LabelName [get, set]
 Returns or sets the label name of this sheet element. More...
 
unsafe
NXOpen.Diagramming.LocationBuilder 
Location [get]
 Returns the location of the sheet element relative to another sheet element. More...
 
unsafe
NXOpen.Diagramming.DiagrammingLocationstyle 
LocationStyle [get, set]
 Returns or sets the location style. More...
 
unsafe bool MirrorX [get, set]
 Returns or sets the sheet element to Mirror along the X axis. More...
 
unsafe bool MirrorY [get, set]
 Returns or sets the sheet element to Mirror along the Y axis. More...
 
unsafe
NXOpen.Diagramming.SheetElement 
Owner [get, set]
 Returns or sets the owning sheet element. More...
 
unsafe NXOpen.Diagramming.Sheet OwningSheet [get]
 Returns the owning sheet. More...
 
unsafe
NXOpen.Diagramming.SheetElementBuilder.ResizeOptionType 
ResizeOption [get, set]
 Returns or sets the resize option of the sheet element More...
 
unsafe double Rotation [get, set]
 Returns or sets the rotation angle that is counter clockwise and relative to the owner. More...
 
unsafe
NXOpen.Diagramming.SheetElement 
SourceElement [get]
 Returns the source element that records which sheet element it is a copy of. More...
 
unsafe bool UpToDate [get]
 Returns the flag that indicates if the sheet element is up to date. More...
 
unsafe bool Visible [get]
 Returns the flag that indicates if the sheet element is visible. More...
 
unsafe double Width [get, set]
 Returns or sets the width. More...
 
unsafe
NXOpen.Diagramming.DiagrammingSizingpolicy 
WidthPolicy [get, set]
 Returns or sets the width policy. More...
 
unsafe double X [get, set]
 Returns or sets the absolute x coordinate. More...
 
unsafe double Y [get, set]
 Returns or sets the absolute y coordinate. More...
 
unsafe int ZDepth [get, set]
 Returns or sets the Z depth. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a SheetElementBuilder.

This is an abstract class and cannot be directly instantiated

Created in NX10.0.0

Member Enumeration Documentation

Represents the resize option for a NXOpen.Diagramming.SheetElementBuilder .

Enumerator
AnyDirection 
OnAnchor 
SameRatio 
SameRationOnCorner 
SameRatioOnEdge 

Member Function Documentation

unsafe void NXOpen.Diagramming.SheetElementBuilder.GetAllowedTransformations ( out bool  isAllowedTranslation,
out bool  isAllowedRotation,
out bool  isAllowedScale,
out bool  isAllowedShear 
)
inline

Get the allowed transformations of the sheet element.

Created in NX10.0.0

License requirements: None.

Parameters
isAllowedTranslation
isAllowedRotation
isAllowedScale
isAllowedShear
unsafe void NXOpen.Diagramming.SheetElementBuilder.GetMinNodeSize ( out double[]  sizeValues)
inline

Gets the minimum node size values

Created in NX11.0.0

License requirements: None.

Parameters
sizeValuesMinimum node size values as output
unsafe void NXOpen.Diagramming.SheetElementBuilder.SetMinNodeSize ( double[]  sizeValues)
inline

Sets the minimum node size values

Created in NX11.0.0

License requirements: None.

Parameters
sizeValuesMinimum node size values as input
unsafe void NXOpen.Diagramming.SheetElementBuilder.SetOwningSheet ( NXOpen.Diagramming.Sheet  owningSheet)
inline

Set the owning sheet when the sheet element is created.

It is not allowed to change the owning sheet when editing the sheet element.

Created in NX10.0.0

License requirements: None.

Parameters
owningSheet

Property Documentation

unsafe double NXOpen.Diagramming.SheetElementBuilder.Height
getset

Returns or sets the height.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.DiagrammingSizingpolicy NXOpen.Diagramming.SheetElementBuilder.HeightPolicy
getset

Returns or sets the height policy.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetElementBuilder.Internal
get

Returns the flag that indicates if the sheet element is internal.

If false it is not part of the user's data model; for example, an Annotation is not part of the user's model of Nodes and Connections.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.Annotation NXOpen.Diagramming.SheetElementBuilder.Label
get

Returns the label of this sheet element.

Created in NX10.0.0

License requirements: None.

unsafe string NXOpen.Diagramming.SheetElementBuilder.LabelName
getset

Returns or sets the label name of this sheet element.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.LocationBuilder NXOpen.Diagramming.SheetElementBuilder.Location
get

Returns the location of the sheet element relative to another sheet element.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.DiagrammingLocationstyle NXOpen.Diagramming.SheetElementBuilder.LocationStyle
getset

Returns or sets the location style.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetElementBuilder.MirrorX
getset

Returns or sets the sheet element to Mirror along the X axis.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetElementBuilder.MirrorY
getset

Returns or sets the sheet element to Mirror along the Y axis.

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.SheetElementBuilder.Owner
getset

Returns or sets the owning sheet element.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.Sheet NXOpen.Diagramming.SheetElementBuilder.OwningSheet
get

Returns the owning sheet.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.SheetElementBuilder.ResizeOptionType NXOpen.Diagramming.SheetElementBuilder.ResizeOption
getset

Returns or sets the resize option of the sheet element

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetElementBuilder.Rotation
getset

Returns or sets the rotation angle that is counter clockwise and relative to the owner.

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.SheetElementBuilder.SourceElement
get

Returns the source element that records which sheet element it is a copy of.

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Diagramming.SheetElementBuilder.UpToDate
get

Returns the flag that indicates if the sheet element is up to date.

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Diagramming.SheetElementBuilder.Visible
get

Returns the flag that indicates if the sheet element is visible.

If true it is visible.

Created in NX10.0.0

License requirements: None.

unsafe double NXOpen.Diagramming.SheetElementBuilder.Width
getset

Returns or sets the width.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.DiagrammingSizingpolicy NXOpen.Diagramming.SheetElementBuilder.WidthPolicy
getset

Returns or sets the width policy.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetElementBuilder.X
getset

Returns or sets the absolute x coordinate.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetElementBuilder.Y
getset

Returns or sets the absolute y coordinate.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Diagramming.SheetElementBuilder.ZDepth
getset

Returns or sets the Z depth.

Higher values of the Z depth indicates that the object is rendered on top of objects with a lower value.

Created in NX10.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.