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

Represents a FormattedStringBuilder. More...

Inheritance diagram for NXOpen::Diagramming::FormattedStringBuilder:
NXOpen::Diagramming::BaseSubObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AppendFormat (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXString > &attrTitles, const NXString &appendFormat)
 Appends the format and related referenced attributes to this builder. More...
 
void AppendFormat (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXString > &attrTitles, const char *appendFormat)
 Appends the format and related referenced attributes to this builder. More...
 
void ClearFormat ()
 Clears the format and related referenced attributes of this builder. More...
 
NXString Format ()
 Returns the format. More...
 
std::vector< NXStringGetReferencedAttributes (std::vector< NXOpen::NXObject * > &objTags)
 Gets the referenced attributes. More...
 
void SetFormatValue (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXString > &attrTitles, const NXString &format)
 Sets the format and related referenced attributes to this builder. More...
 
void SetFormatValue (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXString > &attrTitles, const char *format)
 Sets the format and related referenced attributes to this builder. More...
 
void SetFormatValue (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXOpen::NXObject * > &parentTags, const std::vector< NXString > &attrTitles, const NXString &format)
 Sets the format and related referenced attributes to this builder in managed mode. More...
 
void SetFormatValue (const std::vector< NXOpen::NXObject * > &objTags, const std::vector< NXOpen::NXObject * > &parentTags, const std::vector< NXString > &attrTitles, const char *format)
 Sets the format and related referenced attributes to this builder in managed mode. More...
 
NXString String ()
 Returns the string. More...
 
- Public Member Functions inherited from NXOpen::Diagramming::BaseSubObjectBuilder
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 FormattedStringBuilder.


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

Created in NX10.0.0.

Member Function Documentation

void NXOpen::Diagramming::FormattedStringBuilder::AppendFormat ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXString > &  attrTitles,
const NXString appendFormat 
)

Appends the format and related referenced attributes to this builder.


Created in NX10.0.0.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
attrTitlesThe titles of the referenced attributes
appendFormatappendformat
void NXOpen::Diagramming::FormattedStringBuilder::AppendFormat ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXString > &  attrTitles,
const char *  appendFormat 
)

Appends the format and related referenced attributes to this builder.


Created in NX10.0.0.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
attrTitlesThe titles of the referenced attributes
appendFormatappendformat
void NXOpen::Diagramming::FormattedStringBuilder::ClearFormat ( )

Clears the format and related referenced attributes of this builder.


Created in NX10.0.0.

License requirements : None

NXString NXOpen::Diagramming::FormattedStringBuilder::Format ( )

Returns the format.


Created in NX10.0.0.

License requirements : None

std::vector<NXString> NXOpen::Diagramming::FormattedStringBuilder::GetReferencedAttributes ( std::vector< NXOpen::NXObject * > &  objTags)

Gets the referenced attributes.

Returns
The titles of the referenced attributes
Created in NX10.0.0.

License requirements : None
Parameters
objTagsThe owners of the referenced attributes
void NXOpen::Diagramming::FormattedStringBuilder::SetFormatValue ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXString > &  attrTitles,
const NXString format 
)

Sets the format and related referenced attributes to this builder.


Created in NX10.0.0.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
attrTitlesThe titles of the referenced attributes
formatformat
void NXOpen::Diagramming::FormattedStringBuilder::SetFormatValue ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXString > &  attrTitles,
const char *  format 
)

Sets the format and related referenced attributes to this builder.


Created in NX10.0.0.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
attrTitlesThe titles of the referenced attributes
formatformat
void NXOpen::Diagramming::FormattedStringBuilder::SetFormatValue ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXOpen::NXObject * > &  parentTags,
const std::vector< NXString > &  attrTitles,
const NXString format 
)

Sets the format and related referenced attributes to this builder in managed mode.


Created in NX11.0.1.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
parentTagsThe owner parents of the referenced attributes
attrTitlesThe titles of the referenced attributes
formatformat
void NXOpen::Diagramming::FormattedStringBuilder::SetFormatValue ( const std::vector< NXOpen::NXObject * > &  objTags,
const std::vector< NXOpen::NXObject * > &  parentTags,
const std::vector< NXString > &  attrTitles,
const char *  format 
)

Sets the format and related referenced attributes to this builder in managed mode.


Created in NX11.0.1.

License requirements : None

Parameters
objTagsThe owners of the referenced attributes
parentTagsThe owner parents of the referenced attributes
attrTitlesThe titles of the referenced attributes
formatformat
NXString NXOpen::Diagramming::FormattedStringBuilder::String ( )

Returns the string.


Created in NX10.0.0.

License requirements : None


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