NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Diagramming::SheetMarginSettingsBuilder Class Reference

The SheetMarginSettings builder
Created in NX11.0.1. More...

Inheritance diagram for NXOpen::Diagramming::SheetMarginSettingsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

double BottomTrimmedMargin ()
 Returns the value of the margin in bottom border. More...
 
double BottomUntrimmedMargin ()
 Returns the distance between bottom of the sheet and bottom trimmed margin. More...
 
bool CreateUntrimmedMargins ()
 Returns the flag indicates to create untrimmed margins or not. More...
 
double LeftTrimmedMargin ()
 Returns the value of the margin in left border. More...
 
double LeftUntrimmedMargin ()
 Returns the distance between left of the sheet and left trimmed margin. More...
 
NXOpen::LineColorFontWidthBuilderMarginLineColorFontWidth ()
 Returns the color, font and width of margin line. More...
 
double RightTrimmedMargin ()
 Returns the value of the margin in right border. More...
 
double RightUntrimmedMargin ()
 Returns the distance between right of the sheet and right trimmed margin. More...
 
void SetBottomTrimmedMargin (double bottomTrimmedMargin)
 Sets the value of the margin in bottom border. More...
 
void SetBottomUntrimmedMargin (double bottomUntrimmedMargin)
 Sets the distance between bottom of the sheet and bottom trimmed margin. More...
 
void SetCreateUntrimmedMargins (bool createUntrimmedMargins)
 Sets the flag indicates to create untrimmed margins or not. More...
 
void SetLeftTrimmedMargin (double leftTrimmedMargin)
 Sets the value of the margin in left border. More...
 
void SetLeftUntrimmedMargin (double leftUntrimmedMargin)
 Sets the distance between left of the sheet and left trimmed margin. More...
 
void SetRightTrimmedMargin (double rightTrimmedMargin)
 Sets the value of the margin in right border. More...
 
void SetRightUntrimmedMargin (double rightUntrimmedMargin)
 Sets the distance between right of the sheet and right trimmed margin. More...
 
void SetTopTrimmedMargin (double topMargin)
 Sets the value of the margin in top border. More...
 
void SetTopUntrimmedMargin (double topUntrimmedMargin)
 Sets the distance between top of the sheet and top trimmed margin. More...
 
double TopTrimmedMargin ()
 Returns the value of the margin in top border. More...
 
double TopUntrimmedMargin ()
 Returns the distance between top of the sheet and top trimmed margin. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

The SheetMarginSettings builder
Created in NX11.0.1.


Member Function Documentation

double NXOpen::Diagramming::SheetMarginSettingsBuilder::BottomTrimmedMargin ( )

Returns the value of the margin in bottom border.


Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::BottomUntrimmedMargin ( )

Returns the distance between bottom of the sheet and bottom trimmed margin.


Created in NX11.0.1.

License requirements : None

bool NXOpen::Diagramming::SheetMarginSettingsBuilder::CreateUntrimmedMargins ( )

Returns the flag indicates to create untrimmed margins or not.


Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::LeftTrimmedMargin ( )

Returns the value of the margin in left border.


Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::LeftUntrimmedMargin ( )

Returns the distance between left of the sheet and left trimmed margin.


Created in NX11.0.1.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Diagramming::SheetMarginSettingsBuilder::MarginLineColorFontWidth ( )

Returns the color, font and width of margin line.


Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::RightTrimmedMargin ( )

Returns the value of the margin in right border.


Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::RightUntrimmedMargin ( )

Returns the distance between right of the sheet and right trimmed margin.


Created in NX11.0.1.

License requirements : None

void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetBottomTrimmedMargin ( double  bottomTrimmedMargin)

Sets the value of the margin in bottom border.


Created in NX11.0.1.

License requirements : None

Parameters
bottomTrimmedMarginbottomtrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetBottomUntrimmedMargin ( double  bottomUntrimmedMargin)

Sets the distance between bottom of the sheet and bottom trimmed margin.


Created in NX11.0.1.

License requirements : None

Parameters
bottomUntrimmedMarginbottomuntrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetCreateUntrimmedMargins ( bool  createUntrimmedMargins)

Sets the flag indicates to create untrimmed margins or not.


Created in NX10.0.0.

License requirements : None

Parameters
createUntrimmedMarginscreateuntrimmedmargins
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetLeftTrimmedMargin ( double  leftTrimmedMargin)

Sets the value of the margin in left border.


Created in NX11.0.1.

License requirements : None

Parameters
leftTrimmedMarginlefttrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetLeftUntrimmedMargin ( double  leftUntrimmedMargin)

Sets the distance between left of the sheet and left trimmed margin.


Created in NX11.0.1.

License requirements : None

Parameters
leftUntrimmedMarginleftuntrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetRightTrimmedMargin ( double  rightTrimmedMargin)

Sets the value of the margin in right border.


Created in NX11.0.1.

License requirements : None

Parameters
rightTrimmedMarginrighttrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetRightUntrimmedMargin ( double  rightUntrimmedMargin)

Sets the distance between right of the sheet and right trimmed margin.


Created in NX11.0.1.

License requirements : None

Parameters
rightUntrimmedMarginrightuntrimmedmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetTopTrimmedMargin ( double  topMargin)

Sets the value of the margin in top border.


Created in NX11.0.1.

License requirements : None

Parameters
topMargintopmargin
void NXOpen::Diagramming::SheetMarginSettingsBuilder::SetTopUntrimmedMargin ( double  topUntrimmedMargin)

Sets the distance between top of the sheet and top trimmed margin.


Created in NX11.0.1.

License requirements : None

Parameters
topUntrimmedMargintopuntrimmedmargin
double NXOpen::Diagramming::SheetMarginSettingsBuilder::TopTrimmedMargin ( )

Returns the value of the margin in top border.


Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetMarginSettingsBuilder::TopUntrimmedMargin ( )

Returns the distance between top of the sheet and top trimmed margin.


Created in NX11.0.1.

License requirements : None

virtual bool NXOpen::Diagramming::SheetMarginSettingsBuilder::Validate ( )
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.


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