NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Annotations::TitleBlockCollection Class Reference

Represents a collection of Annotations::TitleBlock . More...

Inheritance diagram for NXOpen::Annotations::TitleBlockCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element.
 
NXOpen::Annotations::TitleBlockCellBuilderCreateCellBuilder (NXOpen::DisplayableObject *object, bool isLocked, int contentType, const NXString &value, const NXString &label, bool canLockStatusChange)
 Creates a cell builder.
 
NXOpen::Annotations::TitleBlockCellBuilderCreateCellBuilder (NXOpen::DisplayableObject *object, bool isLocked, int contentType, const char *value, const char *label, bool canLockStatusChange)
 Creates a cell builder.
 
NXOpen::Annotations::DefineTitleBlockBuilderCreateDefineTitleBlockBuilder (NXOpen::Annotations::TitleBlock *titleblock)
 Creates a Annotations::DefineTitleBlockBuilder .
 
NXOpen::Annotations::EditTitleBlockBuilderCreateEditTitleBlockBuilder (const std::vector< NXOpen::Annotations::TitleBlock * > &titleBlocks)
 Creates a Annotations::EditTitleBlockBuilder .
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a collection of Annotations::TitleBlock .


To obtain an instance of this class, refer to Drafting::DraftingApplicationManager

Created in NX8.0.0.

Member Function Documentation

iterator NXOpen::Annotations::TitleBlockCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Annotations::TitleBlockCellBuilder* NXOpen::Annotations::TitleBlockCollection::CreateCellBuilder ( NXOpen::DisplayableObject object,
bool  isLocked,
int  contentType,
const NXString value,
const NXString label,
bool  canLockStatusChange 
)

Creates a cell builder.

Returns

Created in NX8.0.0.

License requirements : None
Parameters
objectobject
isLockedislocked
contentTypecontenttype
valuevalue
labellabel
canLockStatusChangecanlockstatuschange
NXOpen::Annotations::TitleBlockCellBuilder* NXOpen::Annotations::TitleBlockCollection::CreateCellBuilder ( NXOpen::DisplayableObject object,
bool  isLocked,
int  contentType,
const char *  value,
const char *  label,
bool  canLockStatusChange 
)

Creates a cell builder.

Returns

Created in NX8.0.0.

License requirements : None
Parameters
objectobject
isLockedislocked
contentTypecontenttype
valuevalue
labellabel
canLockStatusChangecanlockstatuschange
NXOpen::Annotations::DefineTitleBlockBuilder* NXOpen::Annotations::TitleBlockCollection::CreateDefineTitleBlockBuilder ( NXOpen::Annotations::TitleBlock titleblock)

Creates a Annotations::DefineTitleBlockBuilder .

       This builder provides functions to create a new title block from 
       tabular notes or add/remove tabular notes from existing title block. 
       It also permits user to edit label and lock status of cells. 
       If you want to edit values of cells in existing 
       title block, please use @link Annotations::EditTitleBlockBuilder Annotations::EditTitleBlockBuilder@endlink .  @return  


Created in NX8.0.0.

License requirements : None

Parameters
titleblocktitleblock
NXOpen::Annotations::EditTitleBlockBuilder* NXOpen::Annotations::TitleBlockCollection::CreateEditTitleBlockBuilder ( const std::vector< NXOpen::Annotations::TitleBlock * > &  titleBlocks)

Creates a Annotations::EditTitleBlockBuilder .

       This builder provides functions for editing values of unlocked cells in one 
       or more title blocks. 
       If you want to create a new title block from tabular notes 
       or add/remove tabular notes from existing title block, please use 
       @link Annotations::DefineTitleBlockBuilder Annotations::DefineTitleBlockBuilder@endlink .  @return  


Created in NX8.0.0.

License requirements : None

Parameters
titleBlockstitleblocks
iterator NXOpen::Annotations::TitleBlockCollection::end ( )

Returns an iterator addressing one past the last element.

tag_t NXOpen::Annotations::TitleBlockCollection::Tag ( ) const

Returns the tag of this object.


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