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.SheetBordersAndZonesBuilder Class Reference

The SheetBordersAndZones builder More...

Inheritance diagram for NXOpen.Diagramming.SheetBordersAndZonesBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ArrowDirectionType { OutofSheet, IntoSheet }
 Represents the arrow direction type More...
 
enum  ArrowStyleType { Filled, Closed, ClosedSolid, Open }
 Represents the arrow style type More...
 
enum  HorizontalCenteringMarkType {
  None, LeftArrow, RightArrow, LeftandRightArrow,
  LeftandRightLine
}
 Represents the horizontal centering mark type. More...
 
enum  TrimmingMarkStyleType { Triangle, Corner }
 Represents the trimming mark style type More...
 
enum  VerticalCenteringMarkType {
  None, BottomArrow, TopArrow, BottomandTopArrow,
  BottomandTopLine
}
 Represents the vertical centering mark type. More...
 
enum  ZoneMethod { None, Standard, Custom }
 Represents the zone method. More...
 
enum  ZoneOrigin { BottomRight, TopLeft, TopRight, BottomLeft }
 Represents the zone origin. More...
 

Public Member Functions

unsafe void SetOwningSheet (NXOpen.Diagramming.Sheet owningSheet)
 Set the owning sheet when the sheet element is created. 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...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe double BottomMargin [get, set]
 Returns or sets the value of the margin in bottom border. More...
 
unsafe double CenteringMarkExtension [get, set]
 Returns or sets the length of centering marks extension from inner border More...
 
unsafe bool CreateBorders [get, set]
 Returns or sets the flag that indicates if borders are created. More...
 
unsafe bool CreateTrimmingMarks [get, set]
 Returns or sets the flag that indicate if trimming marks are created. More...
 
unsafe bool CreateZoneLabels [get, set]
 Returns or sets the flag that indicates if zone labels are created. More...
 
unsafe bool CreateZoneMarking [get, set]
 Returns or sets the flag that indicates if zone marking is create. More...
 
unsafe
NXOpen.Diagramming.SheetBordersAndZonesBuilder.HorizontalCenteringMarkType 
HorizontalCenteringMark [get, set]
 Returns or sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow. More...
 
unsafe double HorizontalSize [get, set]
 Returns or sets the size of horizontal zones. More...
 
unsafe int LabelFont [get, set]
 Returns or sets the font of the label(text). More...
 
unsafe double LabelHeight [get, set]
 Returns or sets the height of the label(text). More...
 
unsafe double LeftMargin [get, set]
 Returns or sets the value of the margin in left border. More...
 
unsafe double MarkingHeight [get, set]
 Returns or sets the height of marking. More...
 
unsafe
NXOpen.Diagramming.SheetBordersAndZonesBuilder.ZoneMethod 
Method [get, set]
 Returns or sets the type of methods to create the zones. More...
 
unsafe
NXOpen.Diagramming.SheetBordersAndZonesBuilder.ZoneOrigin 
Origin [get, set]
 Returns or sets the type of zone origin like TopLeft/BottomRight. More...
 
unsafe double RightMargin [get, set]
 Returns or sets the value of the margin in right border. More...
 
unsafe
NXOpen.Diagramming.SheetBorderSettingsBuilder 
SheetBorderSettings [get]
 Returns the sheet border settings builder used to get the values related to borders More...
 
unsafe
NXOpen.Diagramming.SheetMarginSettingsBuilder 
SheetMarginSettings [get]
 Returns the sheet margin settings builder used to get the values related to margins More...
 
unsafe
NXOpen.Diagramming.SheetZoneSettingsBuilder 
SheetZoneSettings [get]
 Returns the sheet zone settings builder used to get the values related to zones More...
 
unsafe double TopMargin [get, set]
 Returns or sets the value of the margin in top border. More...
 
unsafe double TrimmingMarkLength [get, set]
 Returns or sets the length of trimming mark. More...
 
unsafe double TrimmingMarkThickness [get, set]
 Returns or sets the width of trimming mark. More...
 
unsafe
NXOpen.Diagramming.SheetBordersAndZonesBuilder.VerticalCenteringMarkType 
VerticalCenteringMark [get, set]
 Returns or sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow. More...
 
unsafe double VerticalSize [get, set]
 Returns or sets the size of vertical zones. More...
 
unsafe double Width [get, set]
 Returns or sets the width of border. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

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

Detailed Description

The SheetBordersAndZones builder

To create a new instance of this class, use NXOpen.Diagramming.SheetBordersAndZonesCollection.CreateSheetBordersAndZonesBuilder

Created in NX10.0.0

Member Enumeration Documentation

Represents the arrow direction type

Enumerator
OutofSheet 

Out of Sheet

IntoSheet 

Represents the arrow style type

Enumerator
Filled 

Filled

Closed 

Closed

ClosedSolid 

Close Solid

Open 

Represents the horizontal centering mark type.

Enumerator
None 

None

LeftArrow 

Left Arrow

RightArrow 

Right Arrow

LeftandRightArrow 

Left and Right Arrow

LeftandRightLine 

Represents the trimming mark style type

Enumerator
Triangle 

Triangle

Corner 

Represents the vertical centering mark type.

Enumerator
None 

None

BottomArrow 

Bottom Arrow

TopArrow 

Top Arrow

BottomandTopArrow 

Bottom and Top Arrow

BottomandTopLine 

Represents the zone method.

Enumerator
None 

None

Standard 

Standard

Custom 

Represents the zone origin.

Enumerator
BottomRight 

Bottom Right

TopLeft 

Top Left

TopRight 

Top Right

BottomLeft 

Member Function Documentation

unsafe void NXOpen.Diagramming.SheetBordersAndZonesBuilder.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 borders and zones.

Created in NX10.0.0

License requirements: None.

Parameters
owningSheet

Property Documentation

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.BottomMargin
getset

Returns or sets the value of the margin in bottom border.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetMarginSettingsBuilder.BottomTrimmedMargin</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.CenteringMarkExtension
getset

Returns or sets the length of centering marks extension from inner border

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.CenteringMarksExtension</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetBordersAndZonesBuilder.CreateBorders
getset

Returns or sets the flag that indicates if borders are created.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.CreateBorders</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetBordersAndZonesBuilder.CreateTrimmingMarks
getset

Returns or sets the flag that indicate if trimming marks are created.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.CreateTrimmingMarks</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetBordersAndZonesBuilder.CreateZoneLabels
getset

Returns or sets the flag that indicates if zone labels are created.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.CreateZoneLabels</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.SheetBordersAndZonesBuilder.CreateZoneMarking
getset

Returns or sets the flag that indicates if zone marking is create.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.CreateZoneMarkings</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetBordersAndZonesBuilder.HorizontalCenteringMarkType NXOpen.Diagramming.SheetBordersAndZonesBuilder.HorizontalCenteringMark
getset

Returns or sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.CenteringMarksHorizontal</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.HorizontalSize
getset

Returns or sets the size of horizontal zones.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.HorizontalSize</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Diagramming.SheetBordersAndZonesBuilder.LabelFont
getset

Returns or sets the font of the label(text).

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.LabelFont</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.LabelHeight
getset

Returns or sets the height of the label(text).

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.LabelHeight</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.LeftMargin
getset

Returns or sets the value of the margin in left border.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetMarginSettingsBuilder.LeftTrimmedMargin</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.MarkingHeight
getset

Returns or sets the height of marking.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.MarkingHeight</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetBordersAndZonesBuilder.ZoneMethod NXOpen.Diagramming.SheetBordersAndZonesBuilder.Method
getset

Returns or sets the type of methods to create the zones.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.Method</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetBordersAndZonesBuilder.ZoneOrigin NXOpen.Diagramming.SheetBordersAndZonesBuilder.Origin
getset

Returns or sets the type of zone origin like TopLeft/BottomRight.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.Origin</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.RightMargin
getset

Returns or sets the value of the margin in right border.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetMarginSettingsBuilder.RightTrimmedMargin</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetBorderSettingsBuilder NXOpen.Diagramming.SheetBordersAndZonesBuilder.SheetBorderSettings
get

Returns the sheet border settings builder used to get the values related to borders

Created in NX11.0.1

License requirements: None.

unsafe NXOpen.Diagramming.SheetMarginSettingsBuilder NXOpen.Diagramming.SheetBordersAndZonesBuilder.SheetMarginSettings
get

Returns the sheet margin settings builder used to get the values related to margins

Created in NX11.0.1

License requirements: None.

unsafe NXOpen.Diagramming.SheetZoneSettingsBuilder NXOpen.Diagramming.SheetBordersAndZonesBuilder.SheetZoneSettings
get

Returns the sheet zone settings builder used to get the values related to zones

Created in NX11.0.1

License requirements: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.TopMargin
getset

Returns or sets the value of the margin in top border.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetMarginSettingsBuilder.TopTrimmedMargin</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.TrimmingMarkLength
getset

Returns or sets the length of trimming mark.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.TrimmingMarkLength</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.TrimmingMarkThickness
getset

Returns or sets the width of trimming mark.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.TrimmingMarkWidth</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.SheetBordersAndZonesBuilder.VerticalCenteringMarkType NXOpen.Diagramming.SheetBordersAndZonesBuilder.VerticalCenteringMark
getset

Returns or sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.CenteringMarksVertical</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.VerticalSize
getset

Returns or sets the size of vertical zones.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetZoneSettingsBuilder.VerticalSize</ja_property_get> instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Diagramming.SheetBordersAndZonesBuilder.Width
getset

Returns or sets the width of border.

It should be greater than zero.

Created in NX10.0.0

Deprecated in NX12.0.1. Use <ja_property_get>NXOpen.Diagramming.SheetBorderSettingsBuilder.BorderLineWidth</ja_property_get> instead.

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.