NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.Annotations.TableCommonSortingBuilder Class Reference

Annotations.TableCommonSortingBuilder More...

Inheritance diagram for NXOpen.Annotations.TableCommonSortingBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

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

Public Types

enum  MethodType { Alphabetic, Alphanumeric, Manual }
 The sorting method types More...
 
enum  SortingDirection { Descending, Ascending }
 The sorting direction More...
 

Public Member Functions

unsafe int[] GetManualSortRowList ()
 Returns manual sort row order. More...
 
unsafe
NXOpen.Annotations.TableCommonSortingBuilder.SortData[] 
GetSortingData ()
 Get sorting data. More...
 
unsafe void SetManualSortRowList (int[] rowList)
 Sets manual sort row order. More...
 
unsafe void SetSortingData (NXOpen.Annotations.TableCommonSortingBuilder.SortData[] sortingData)
 Set sorting data. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Annotations.TableCommonSortingBuilder.MethodType 
Method [get, set]
 Returns or sets the sorting method More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Annotations.TableCommonSortingBuilder

.

Created in NX1847.0.0

Member Enumeration Documentation

The sorting method types

Enumerator
Alphabetic 

Alphabetic

Alphanumeric 

Alphanumeric

Manual 

Manual

The sorting direction

Enumerator
Descending 

Descending sort direction

Ascending 

Ascending sort direction

Member Function Documentation

unsafe int [] NXOpen.Annotations.TableCommonSortingBuilder.GetManualSortRowList ( )
inline

Returns manual sort row order.

This should be used when NXOpen.Annotations.TableCommonSortingBuilder.Method is NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Manual .

Created in NX1847.0.0

License requirements: None.

Returns
Array of row indices for manual sorting
unsafe NXOpen.Annotations.TableCommonSortingBuilder.SortData [] NXOpen.Annotations.TableCommonSortingBuilder.GetSortingData ( )
inline

Get sorting data.

This should be used when NXOpen.Annotations.TableCommonSortingBuilder.Method is NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Alphabetic or NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Alphanumeric

Created in NX1847.0.0

License requirements: None.

Returns
Array of sorting data for Alphabetic/Alphanumeric sorting
unsafe void NXOpen.Annotations.TableCommonSortingBuilder.SetManualSortRowList ( int[]  rowList)
inline

Sets manual sort row order.

This should be used when NXOpen.Annotations.TableCommonSortingBuilder.Method is NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Manual .

Created in NX1847.0.0

License requirements: None.

Parameters
rowListArray of row indices for manual sorting
unsafe void NXOpen.Annotations.TableCommonSortingBuilder.SetSortingData ( NXOpen.Annotations.TableCommonSortingBuilder.SortData[]  sortingData)
inline

Set sorting data.

This should be used when NXOpen.Annotations.TableCommonSortingBuilder.Method is NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Alphabetic or NXOpen.Annotations.TableCommonSortingBuilder.MethodType.Alphanumeric

Created in NX1847.0.0

License requirements: None.

Parameters
sortingDataArray of sorting data for Alphabetic/Alphanumeric sorting
unsafe bool NXOpen.Annotations.TableCommonSortingBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Annotations.TableCommonSortingBuilder.MethodType NXOpen.Annotations.TableCommonSortingBuilder.Method
getset

Returns or sets the sorting method

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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