NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Diagramming::Tables::CellBuilder Class Reference

Represents a CellBuilder. More...

Inheritance diagram for NXOpen::Diagramming::Tables::CellBuilder:
NXOpen::Diagramming::BaseTaggedObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  InheritOption { InheritOptionPreferences, InheritOptionCustomerDefaults, InheritOptionSelection }
 Represents the inherit option. More...
 

Public Member Functions

NXOpen::Diagramming::RenderingPropertiesBuilderBottomBorder ()
 Returns the bottom border line rendering properties. More...
 
void DeleteContent ()
 Delete cell contents. More...
 
NXOpen::Diagramming::FormattedStringBuilderFormattedStringBuilder ()
 Returns the formatted string of the text. More...
 
NXOpen::Diagramming::Tables::CellSettingsBuilderGetCellSettings ()
 Gets cell settings. More...
 
std::vector
< NXOpen::Diagramming::Tables::SizedSymbol
GetContent ()
 Gets cell content. More...
 
void Inherit (NXOpen::Diagramming::Tables::CellBuilder::InheritOption inheritOption, NXOpen::TaggedObject *elementToInheritFrom)
 Inherit. More...
 
NXOpen::Diagramming::RenderingPropertiesBuilderLeftBorder ()
 Returns the left border line rendering properties. More...
 
bool Locked ()
 Returns the locked flag. More...
 
double Padding ()
 Returns the cell padding. More...
 
NXOpen::Diagramming::RenderingPropertiesBuilderRightBorder ()
 Returns the right border line rendering properties. More...
 
void SetBottomBorder (NXOpen::Diagramming::RenderingPropertiesBuilder *properties)
 Sets the bottom border line rendering properties. More...
 
void SetContent (const std::vector< NXOpen::Diagramming::Tables::SizedSymbol > &symbols)
 Sets cell content. More...
 
void SetImageFileLocation (const NXString &fileName)
 Sets cell image file location. More...
 
void SetImageFileLocation (const char *fileName)
 Sets cell image file location. More...
 
void SetLeftBorder (NXOpen::Diagramming::RenderingPropertiesBuilder *properties)
 Sets the left border line rendering properties. More...
 
void SetLocked (bool locked)
 Sets the locked flag. More...
 
void SetPadding (double padding)
 Sets the cell padding. More...
 
void SetRightBorder (NXOpen::Diagramming::RenderingPropertiesBuilder *properties)
 Sets the right border line rendering properties. More...
 
void SetText (const NXString &strValue)
 Sets the text on cell. More...
 
void SetText (const char *strValue)
 Sets the text on cell. More...
 
void SetTopBorder (NXOpen::Diagramming::RenderingPropertiesBuilder *properties)
 Sets the top border line rendering properties. More...
 
NXString Text ()
 Returns the text on cell. More...
 
NXOpen::Diagramming::RenderingPropertiesBuilderTopBorder ()
 Returns the top border line rendering properties. More...
 
- Public Member Functions inherited from NXOpen::Diagramming::BaseTaggedObjectBuilder
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

Represents a CellBuilder.


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

Created in NX10.0.0.

Member Enumeration Documentation

Represents the inherit option.


Created in NX11.0.0.

Enumerator
InheritOptionPreferences 

Setting the inherit from preferences option.

InheritOptionCustomerDefaults 

Setting the inherit from customer defaults option.

InheritOptionSelection 

Setting the inherit from selection option.

Member Function Documentation

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::CellBuilder::BottomBorder ( )

Returns the bottom border line rendering properties.


Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::CellBuilder::DeleteContent ( )

Delete cell contents.


Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::FormattedStringBuilder* NXOpen::Diagramming::Tables::CellBuilder::FormattedStringBuilder ( )

Returns the formatted string of the text.


Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::Tables::CellSettingsBuilder* NXOpen::Diagramming::Tables::CellBuilder::GetCellSettings ( )

Gets cell settings.


Created in NX10.0.0.

License requirements : None

std::vector<NXOpen::Diagramming::Tables::SizedSymbol> NXOpen::Diagramming::Tables::CellBuilder::GetContent ( )

Gets cell content.


Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::CellBuilder::Inherit ( NXOpen::Diagramming::Tables::CellBuilder::InheritOption  inheritOption,
NXOpen::TaggedObject elementToInheritFrom 
)

Inherit.

elementToInheritFrom must be Table or Cell object
Created in NX1847.0.0.

License requirements : None

Parameters
inheritOptioninheritoption
elementToInheritFromelementtoinheritfrom
NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::CellBuilder::LeftBorder ( )

Returns the left border line rendering properties.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::Tables::CellBuilder::Locked ( )

Returns the locked flag.


Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::Tables::CellBuilder::Padding ( )

Returns the cell padding.


Created in NX1847.0.0.

License requirements : None

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::CellBuilder::RightBorder ( )

Returns the right border line rendering properties.


Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::CellBuilder::SetBottomBorder ( NXOpen::Diagramming::RenderingPropertiesBuilder properties)

Sets the bottom border line rendering properties.


Created in NX10.0.0.

License requirements : None

Parameters
propertiesproperties
void NXOpen::Diagramming::Tables::CellBuilder::SetContent ( const std::vector< NXOpen::Diagramming::Tables::SizedSymbol > &  symbols)

Sets cell content.


Created in NX10.0.0.

License requirements : None

Parameters
symbolssymbols
void NXOpen::Diagramming::Tables::CellBuilder::SetImageFileLocation ( const NXString fileName)

Sets cell image file location.


Created in NX10.0.0.

License requirements : None

Parameters
fileNamefilename
void NXOpen::Diagramming::Tables::CellBuilder::SetImageFileLocation ( const char *  fileName)

Sets cell image file location.


Created in NX10.0.0.

License requirements : None

Parameters
fileNamefilename
void NXOpen::Diagramming::Tables::CellBuilder::SetLeftBorder ( NXOpen::Diagramming::RenderingPropertiesBuilder properties)

Sets the left border line rendering properties.


Created in NX10.0.0.

License requirements : None

Parameters
propertiesproperties
void NXOpen::Diagramming::Tables::CellBuilder::SetLocked ( bool  locked)

Sets the locked flag.


Created in NX10.0.0.

License requirements : None

Parameters
lockedlocked
void NXOpen::Diagramming::Tables::CellBuilder::SetPadding ( double  padding)

Sets the cell padding.


Created in NX1847.0.0.

License requirements : None

Parameters
paddingpadding
void NXOpen::Diagramming::Tables::CellBuilder::SetRightBorder ( NXOpen::Diagramming::RenderingPropertiesBuilder properties)

Sets the right border line rendering properties.


Created in NX10.0.0.

License requirements : None

Parameters
propertiesproperties
void NXOpen::Diagramming::Tables::CellBuilder::SetText ( const NXString strValue)

Sets the text on cell.


Created in NX10.0.0.

License requirements : None

Parameters
strValuestrvalue
void NXOpen::Diagramming::Tables::CellBuilder::SetText ( const char *  strValue)

Sets the text on cell.


Created in NX10.0.0.

License requirements : None

Parameters
strValuestrvalue
void NXOpen::Diagramming::Tables::CellBuilder::SetTopBorder ( NXOpen::Diagramming::RenderingPropertiesBuilder properties)

Sets the top border line rendering properties.


Created in NX10.0.0.

License requirements : None

Parameters
propertiesproperties
NXString NXOpen::Diagramming::Tables::CellBuilder::Text ( )

Returns the text on cell.


Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::CellBuilder::TopBorder ( )

Returns the top border line rendering properties.


Created in NX10.0.0.

License requirements : None


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