Represents a. More...

Inheritance diagram for NXOpen::Annotations::TableCommonSortingBuilder:

Classes
struct	SortData
	Sort data used to specify column position and sorting direction. More...

Public Types
enum	MethodType { MethodTypeAlphabetic, MethodTypeAlphanumeric, MethodTypeManual }
	The sorting method types. More...

enum	SortingDirection { SortingDirectionDescending, SortingDirectionAscending }
	The sorting direction. More...

Public Member Functions
std::vector< int >	GetManualSortRowList ()
	Returns manual sort row order. More...

std::vector < NXOpen::Annotations::TableCommonSortingBuilder::SortData >	GetSortingData ()
	Get sorting data. More...

NXOpen::Annotations::TableCommonSortingBuilder::MethodType	Method ()
	Returns the sorting method Created in NX1847.0.0. More...

void	SetManualSortRowList (const std::vector< int > &rowList)
	Sets manual sort row order. More...

void	SetMethod (NXOpen::Annotations::TableCommonSortingBuilder::MethodType method)
	Sets the sorting method Created in NX1847.0.0. More...

void	SetSortingData (const std::vector< NXOpen::Annotations::TableCommonSortingBuilder::SortData > &sortingData)
	Set sorting data. 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

Represents a.

Annotations.TableCommonSortingBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::TableCommonSortingBuilder::MethodType

The sorting method types.

Enumerator
MethodTypeAlphabetic	Alphabetic.
MethodTypeAlphanumeric	Alphanumeric.
MethodTypeManual	Manual.

enum NXOpen::Annotations::TableCommonSortingBuilder::SortingDirection

The sorting direction.

Enumerator
SortingDirectionDescending	Descending sort direction.
SortingDirectionAscending	Ascending sort direction.

Member Function Documentation

std::vector<int> NXOpen::Annotations::TableCommonSortingBuilder::GetManualSortRowList ( )

Returns manual sort row order.

This should be used when NXOpen::Annotations::TableCommonSortingBuilder::Method and NXOpen::Annotations::TableCommonSortingBuilder::SetMethod is NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeManual .

Returns: Array of row indices for manual sorting
Created in NX1847.0.0.

License requirements : None

std::vector<NXOpen::Annotations::TableCommonSortingBuilder::SortData> NXOpen::Annotations::TableCommonSortingBuilder::GetSortingData ( )

Get sorting data.

This should be used when NXOpen::Annotations::TableCommonSortingBuilder::Method and NXOpen::Annotations::TableCommonSortingBuilder::SetMethod is NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeAlphabetic or NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeAlphanumeric

Returns: Array of sorting data for Alphabetic/Alphanumeric sorting
Created in NX1847.0.0.

License requirements : None

NXOpen::Annotations::TableCommonSortingBuilder::MethodType NXOpen::Annotations::TableCommonSortingBuilder::Method ( )

Returns the sorting method
Created in NX1847.0.0.

License requirements : None

void NXOpen::Annotations::TableCommonSortingBuilder::SetManualSortRowList ( const std::vector< int > & rowList )

Sets manual sort row order.

This should be used when NXOpen::Annotations::TableCommonSortingBuilder::Method and NXOpen::Annotations::TableCommonSortingBuilder::SetMethod is NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeManual .
Created in NX1847.0.0.

License requirements : None

Parameters

rowList Array of row indices for manual sorting

void NXOpen::Annotations::TableCommonSortingBuilder::SetMethod ( NXOpen::Annotations::TableCommonSortingBuilder::MethodType method )

Sets the sorting method
Created in NX1847.0.0.

License requirements : None

Parameters

method Sort method

void NXOpen::Annotations::TableCommonSortingBuilder::SetSortingData ( const std::vector< NXOpen::Annotations::TableCommonSortingBuilder::SortData > & sortingData )

Set sorting data.

This should be used when NXOpen::Annotations::TableCommonSortingBuilder::Method and NXOpen::Annotations::TableCommonSortingBuilder::SetMethod is NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeAlphabetic or NXOpen::Annotations::TableCommonSortingBuilder::MethodTypeAlphanumeric
Created in NX1847.0.0.

License requirements : None

Parameters

sortingData Array of sorting data for Alphabetic/Alphanumeric sorting

virtual bool NXOpen::Annotations::TableCommonSortingBuilder::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:

Annotations_TableCommonSortingBuilder.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation