The SheetZoneSettings builder
Created in NX11.0.1.
More...
Public Member Functions | |
| bool | ContinueZoneIndexingAcrossSheets () |
| Returns the flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not. More... | |
| double | CornerZoneModification () |
| Returns the corner zone modification used as determine the size of the corner zone. More... | |
| bool | CreateZoneLabels () |
| Returns the flag indicates to create zone labels or not. More... | |
| bool | CreateZoneMarkings () |
| Returns the flag indicates to create zone markings or not. More... | |
| bool | CreateZones () |
| Returns the flag indicates to create zones or not. More... | |
| double | HorizontalSize () |
| Returns the size of the horizontal zone. More... | |
| int | LabelColor () |
| Returns the color of the label(text). More... | |
| int | LabelFont () |
| Returns the font of the label(text). More... | |
| double | LabelHeight () |
| Returns the height of the label(text). More... | |
| bool | LabelItalicized () |
| Returns the flag indicates the label(text) is italic or not. More... | |
| NXString | LabelsToSkip () |
| Returns the characters to skip in label(text). More... | |
| int | LabelWidth () |
| Returns the width of the label(text) like Regular, Bold. More... | |
| double | MarkingHeight () |
| Returns the height of the marking. More... | |
| NXOpen::LineColorFontWidthBuilder * | MarkingLineColorWidth () |
| Returns the color and width of marking line. More... | |
| NXOpen::Diagramming::ZoneOrigin | Origin () |
| Returns the type of zone origin like TopLeft/BottomRight. More... | |
| void | SetContinueZoneIndexingAcrossSheets (bool continueZoneIndexingAcrossSheets) |
| Sets the flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not. More... | |
| void | SetCornerZoneModification (double cornerZoneModification) |
| Sets the corner zone modification used as determine the size of the corner zone. More... | |
| void | SetCreateZoneLabels (bool createZoneLabels) |
| Sets the flag indicates to create zone labels or not. More... | |
| void | SetCreateZoneMarkings (bool createZoneMarkings) |
| Sets the flag indicates to create zone markings or not. More... | |
| void | SetCreateZones (bool createZones) |
| Sets the flag indicates to create zones or not. More... | |
| void | SetHorizontalSize (double horizontalSize) |
| Sets the size of the horizontal zone. More... | |
| void | SetLabelColor (int labelColor) |
| Sets the color of the label(text). More... | |
| void | SetLabelFont (int labelFont) |
| Sets the font of the label(text). More... | |
| void | SetLabelHeight (double labelHeight) |
| Sets the height of the label(text). More... | |
| void | SetLabelItalicized (bool italic) |
| Sets the flag indicates the label(text) is italic or not. More... | |
| void | SetLabelsToSkip (const NXString &labelsToSkip) |
| Sets the characters to skip in label(text). More... | |
| void | SetLabelsToSkip (const char *labelsToSkip) |
| Sets the characters to skip in label(text). More... | |
| void | SetLabelWidth (int labelWidth) |
| Sets the width of the label(text) like Regular, Bold. More... | |
| void | SetMarkingHeight (double markingHeight) |
| Sets the height of the marking. More... | |
| void | SetOrigin (NXOpen::Diagramming::ZoneOrigin origin) |
| Sets the type of zone origin like TopLeft/BottomRight. More... | |
| void | SetVerticalSize (double verticalSize) |
| Sets the size of the vertical zone. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| double | VerticalSize () |
| Returns the size of the vertical zone. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
The SheetZoneSettings builder
Created in NX11.0.1.
Member Function Documentation
| bool NXOpen::Diagramming::SheetZoneSettingsBuilder::ContinueZoneIndexingAcrossSheets | ( | ) |
Returns the flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not.
Created in NX11.0.1.
License requirements : None
| double NXOpen::Diagramming::SheetZoneSettingsBuilder::CornerZoneModification | ( | ) |
Returns the corner zone modification used as determine the size of the corner zone.
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Diagramming::SheetZoneSettingsBuilder::CreateZoneLabels | ( | ) |
Returns the flag indicates to create zone labels or not.
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Diagramming::SheetZoneSettingsBuilder::CreateZoneMarkings | ( | ) |
Returns the flag indicates to create zone markings or not.
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Diagramming::SheetZoneSettingsBuilder::CreateZones | ( | ) |
Returns the flag indicates to create zones or not.
Created in NX11.0.1.
License requirements : None
| double NXOpen::Diagramming::SheetZoneSettingsBuilder::HorizontalSize | ( | ) |
Returns the size of the horizontal zone.
It must be greater than zero.
Created in NX11.0.1.
License requirements : None
| int NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelColor | ( | ) |
Returns the color of the label(text).
Created in NX11.0.1.
License requirements : None
| int NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelFont | ( | ) |
Returns the font of the label(text).
Created in NX11.0.1.
License requirements : None
| double NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelHeight | ( | ) |
Returns the height of the label(text).
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelItalicized | ( | ) |
Returns the flag indicates the label(text) is italic or not.
Created in NX11.0.1.
License requirements : None
| NXString NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelsToSkip | ( | ) |
Returns the characters to skip in label(text).
Created in NX11.0.1.
License requirements : None
| int NXOpen::Diagramming::SheetZoneSettingsBuilder::LabelWidth | ( | ) |
Returns the width of the label(text) like Regular, Bold.
Created in NX11.0.1.
License requirements : None
| double NXOpen::Diagramming::SheetZoneSettingsBuilder::MarkingHeight | ( | ) |
Returns the height of the marking.
Created in NX11.0.1.
License requirements : None
| NXOpen::LineColorFontWidthBuilder* NXOpen::Diagramming::SheetZoneSettingsBuilder::MarkingLineColorWidth | ( | ) |
Returns the color and width of marking line.
Created in NX11.0.1.
License requirements : None
| NXOpen::Diagramming::ZoneOrigin NXOpen::Diagramming::SheetZoneSettingsBuilder::Origin | ( | ) |
Returns the type of zone origin like TopLeft/BottomRight.
Created in NX11.0.1.
License requirements : None
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetContinueZoneIndexingAcrossSheets | ( | bool | continueZoneIndexingAcrossSheets | ) |
Sets the flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not.
Created in NX11.0.1.
License requirements : None
- Parameters
-
continueZoneIndexingAcrossSheets continuezoneindexingacrosssheets
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetCornerZoneModification | ( | double | cornerZoneModification | ) |
Sets the corner zone modification used as determine the size of the corner zone.
Created in NX11.0.1.
License requirements : None
- Parameters
-
cornerZoneModification cornerzonemodification
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetCreateZoneLabels | ( | bool | createZoneLabels | ) |
Sets the flag indicates to create zone labels or not.
Created in NX11.0.1.
License requirements : None
- Parameters
-
createZoneLabels createzonelabels
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetCreateZoneMarkings | ( | bool | createZoneMarkings | ) |
Sets the flag indicates to create zone markings or not.
Created in NX11.0.1.
License requirements : None
- Parameters
-
createZoneMarkings createzonemarkings
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetCreateZones | ( | bool | createZones | ) |
Sets the flag indicates to create zones or not.
Created in NX11.0.1.
License requirements : None
- Parameters
-
createZones createzones
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetHorizontalSize | ( | double | horizontalSize | ) |
Sets the size of the horizontal zone.
It must be greater than zero.
Created in NX11.0.1.
License requirements : None
- Parameters
-
horizontalSize horizontalsize
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelColor | ( | int | labelColor | ) |
Sets the color of the label(text).
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelColor labelcolor
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelFont | ( | int | labelFont | ) |
Sets the font of the label(text).
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelFont labelfont
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelHeight | ( | double | labelHeight | ) |
Sets the height of the label(text).
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelHeight labelheight
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelItalicized | ( | bool | italic | ) |
Sets the flag indicates the label(text) is italic or not.
Created in NX11.0.1.
License requirements : None
- Parameters
-
italic italic
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelsToSkip | ( | const NXString & | labelsToSkip | ) |
Sets the characters to skip in label(text).
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelsToSkip labelstoskip
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelsToSkip | ( | const char * | labelsToSkip | ) |
Sets the characters to skip in label(text).
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelsToSkip labelstoskip
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetLabelWidth | ( | int | labelWidth | ) |
Sets the width of the label(text) like Regular, Bold.
Created in NX11.0.1.
License requirements : None
- Parameters
-
labelWidth labelwidth
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetMarkingHeight | ( | double | markingHeight | ) |
Sets the height of the marking.
Created in NX11.0.1.
License requirements : None
- Parameters
-
markingHeight markingheight
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetOrigin | ( | NXOpen::Diagramming::ZoneOrigin | origin | ) |
Sets the type of zone origin like TopLeft/BottomRight.
Created in NX11.0.1.
License requirements : None
- Parameters
-
origin origin
| void NXOpen::Diagramming::SheetZoneSettingsBuilder::SetVerticalSize | ( | double | verticalSize | ) |
Sets the size of the vertical zone.
It must be greater than zero.
Created in NX11.0.1.
License requirements : None
- Parameters
-
verticalSize verticalsize
|
virtual |
Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.
- Returns
- Was self validation successful
Created in NX3.0.1.
License requirements : None
Implements NXOpen::GeometricUtilities::IComponentBuilder.
| double NXOpen::Diagramming::SheetZoneSettingsBuilder::VerticalSize | ( | ) |
Returns the size of the vertical zone.
It must be greater than zero.
Created in NX11.0.1.
License requirements : None
The documentation for this class was generated from the following file:
- Diagramming_SheetZoneSettingsBuilder.hxx