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

Represents a Annotations::TableCellStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::TableCellStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BorderLocationType {
  BorderLocationTypeAll, BorderLocationTypeLeft, BorderLocationTypeTop, BorderLocationTypeRight,
  BorderLocationTypeBottom, BorderLocationTypeMiddle, BorderLocationTypeCenter
}
 the valid border location types More...
 
enum  FitMethodType {
  FitMethodTypeOverwriteBorder = 1, FitMethodTypeAutoSizeText, FitMethodTypeWrap, FitMethodTypeAbbreviate,
  FitMethodTypeRemoveSpaces, FitMethodTypeAutoSizeRow, FitMethodTypeAutoSizeCol, FitMethodTypeTruncate
}
 the fit method types More...
 
enum  FormatType {
  FormatTypeText = 1, FormatTypeFloat, FormatTypeFixed, FormatTypeGeneral,
  FormatTypeMonetary, FormatTypeComma, FormatTypeFractionHalfSize, FormatTypeFractionThreeQuarterSize,
  FormatTypeFractionFullSize, FormatTypeDegreesDegreeUnits, FormatTypeDegreesRadianUnits, FormatTypePercent,
  FormatTypeDegrees, FormatTypeHex, FormatTypeLogic, FormatTypeDateDmy,
  FormatTypeDateDm, FormatTypeDateMy, FormatTypeDateMdy, FormatTypeDateYmd,
  FormatTypeDateY4md, FormatTypeDateDmyDot, FormatTypeTimeHm, FormatTypeTimeHms,
  FormatTypeHidden, FormatTypeCustom
}
 the valid cell format types More...
 
enum  TabDirectionType { TabDirectionTypeRight, TabDirectionTypeLeft, TabDirectionTypeUp, TabDirectionTypeDown }
 the valid tab direction More...
 
enum  TextAlignmentType {
  TextAlignmentTypeTopLeft = 1, TextAlignmentTypeTopCenter, TextAlignmentTypeTopRight, TextAlignmentTypeMidLeft,
  TextAlignmentTypeMidCenter, TextAlignmentTypeMidRight, TextAlignmentTypeBottomLeft, TextAlignmentTypeBottomCenter,
  TextAlignmentTypeBottomRight
}
 the valid text alignment types More...
 
enum  ZeroDisplayType { ZeroDisplayTypeZero, ZeroDisplayTypeDash, ZeroDisplayTypeEmpty }
 the valid zero display types More...
 

Public Member Functions

int BorderColor ()
 Returns the border color
Created in NX8.0.0.
 
int BorderFont ()
 Returns the border font
Created in NX8.0.0.
 
NXOpen::Annotations::TableCellStyleBuilder::BorderLocationType BorderLocation ()
 Returns the border location
Created in NX8.0.0.
 
int BorderWidth ()
 Returns the border width
Created in NX8.0.0.
 
NXOpen::Annotations::TableCellStyleBuilder::FormatType Format ()
 Returns the cell format
Created in NX8.0.0.
 
std::vector
< NXOpen::Annotations::TableCellStyleBuilder::FitMethodType
GetFitMethods ()
 Returns the fit methods.
 
bool IncrementIsPercentage ()
 Returns the increment as percent flag
Created in NX8.0.0.
 
double IncrementValue ()
 Returns the increment value
Created in NX8.0.0.
 
bool IsAFormula ()
 Returns the is a formula
Created in NX8.0.0.
 
int Precision ()
 Returns the precision
Created in NX8.0.0.
 
NXString Prefix ()
 Returns the prefix
Created in NX8.0.0.
 
bool ProtectCell ()
 Returns the protect cell
Created in NX9.0.0.
 
void SetAFormula (bool isAFormula)
 Sets the is a formula
Created in NX8.0.0.
 
void SetBorderColor (int borderColor)
 Sets the border color
Created in NX8.0.0.
 
void SetBorderFont (int borderFont)
 Sets the border font
Created in NX8.0.0.
 
void SetBorderLocation (NXOpen::Annotations::TableCellStyleBuilder::BorderLocationType borderLocation)
 Sets the border location
Created in NX8.0.0.
 
void SetBorderWidth (int borderWidth)
 Sets the border width
Created in NX8.0.0.
 
void SetFitMethods (const std::vector< NXOpen::Annotations::TableCellStyleBuilder::FitMethodType > &fitMethods)
 Set fit methods
Created in NX8.0.0.
 
void SetFormat (NXOpen::Annotations::TableCellStyleBuilder::FormatType format)
 Sets the cell format
Created in NX8.0.0.
 
void SetIncrementIsPercentage (bool incrementValue)
 Sets the increment as percent flag
Created in NX8.0.0.
 
void SetIncrementValue (double incrementValue)
 Sets the increment value
Created in NX8.0.0.
 
void SetPrecision (int precision)
 Sets the precision
Created in NX8.0.0.
 
void SetPrefix (const NXString &prefix)
 Sets the prefix
Created in NX8.0.0.
 
void SetPrefix (const char *prefix)
 Sets the prefix
Created in NX8.0.0.
 
void SetProtectCell (bool protectCell)
 Sets the protect cell
Created in NX9.0.0.
 
void SetSlantAngle (double slantAngle)
 Sets the slant angle in degrees
Created in NX8.5.0.
 
void SetSuffix (const NXString &suffix)
 Sets the suffix
Created in NX8.0.0.
 
void SetSuffix (const char *suffix)
 Sets the suffix
Created in NX8.0.0.
 
void SetTabDirection (NXOpen::Annotations::TableCellStyleBuilder::TabDirectionType tabDirection)
 Sets the tab direction
Created in NX9.0.0.
 
void SetTextAlignment (NXOpen::Annotations::TableCellStyleBuilder::TextAlignmentType textAlignment)
 Sets the text alignment
Created in NX8.0.0.
 
void SetUrl (const NXString &url)
 Sets the url
Created in NX8.0.0.
 
void SetUrl (const char *url)
 Sets the url
Created in NX8.0.0.
 
void SetZeroDisplay (NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplayType zeroDisplay)
 Sets the zero display
Created in NX8.0.0.
 
double SlantAngle ()
 Returns the slant angle in degrees
Created in NX8.5.0.
 
NXString Suffix ()
 Returns the suffix
Created in NX8.0.0.
 
NXOpen::Annotations::TableCellStyleBuilder::TabDirectionType TabDirection ()
 Returns the tab direction
Created in NX9.0.0.
 
NXOpen::Annotations::TableCellStyleBuilder::TextAlignmentType TextAlignment ()
 Returns the text alignment
Created in NX8.0.0.
 
NXString Url ()
 Returns the url
Created in NX8.0.0.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplayType ZeroDisplay ()
 Returns the zero display
Created in NX8.0.0.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a Annotations::TableCellStyleBuilder .

This class queries and sets preferences for table cells.


Created in NX8.0.0.

Member Enumeration Documentation

the valid border location types

Enumerator:
BorderLocationTypeAll 

all

BorderLocationTypeLeft 

left

BorderLocationTypeTop 

top

BorderLocationTypeRight 

right

BorderLocationTypeBottom 

bottom

BorderLocationTypeMiddle 

middle

BorderLocationTypeCenter 

center

the fit method types

Enumerator:
FitMethodTypeAutoSizeText 

auto size text

FitMethodTypeWrap 

wrap

FitMethodTypeAbbreviate 

abbreviate

FitMethodTypeRemoveSpaces 

remove spaces

FitMethodTypeAutoSizeRow 

auto size row

FitMethodTypeAutoSizeCol 

auto size col

FitMethodTypeTruncate 

truncate

the valid cell format types

Enumerator:
FormatTypeFloat 

float

FormatTypeFixed 

fixed

FormatTypeGeneral 

general

FormatTypeMonetary 

monetary

FormatTypeComma 

comma

FormatTypeFractionHalfSize 

fraction half size

FormatTypeFractionThreeQuarterSize 

fraction three quarter size

FormatTypeFractionFullSize 

fraction full size

FormatTypeDegreesDegreeUnits 

Degrees.

FormatTypeDegreesRadianUnits 

Radians.

FormatTypePercent 

percent

FormatTypeDegrees 

Radians.

FormatTypeHex 

hex

FormatTypeLogic 

logic

FormatTypeDateDmy 

date dmy

FormatTypeDateDm 

date dm

FormatTypeDateMy 

date my

FormatTypeDateMdy 

date mdy

FormatTypeDateYmd 

date ymd

FormatTypeDateY4md 

date y4md

FormatTypeDateDmyDot 

date dmy dot

FormatTypeTimeHm 

time hm

FormatTypeTimeHms 

time hms

FormatTypeHidden 

hidden

FormatTypeCustom 

custom

the valid tab direction

Enumerator:
TabDirectionTypeRight 

right

TabDirectionTypeLeft 

left

TabDirectionTypeUp 

up

TabDirectionTypeDown 

down

the valid text alignment types

Enumerator:
TextAlignmentTypeTopCenter 

Top center.

TextAlignmentTypeTopRight 

Top right.

TextAlignmentTypeMidLeft 

Mid left.

TextAlignmentTypeMidCenter 

Mid center.

TextAlignmentTypeMidRight 

Mid right.

TextAlignmentTypeBottomLeft 

Bottom left.

TextAlignmentTypeBottomCenter 

Bottom center.

TextAlignmentTypeBottomRight 

Bottom right.

the valid zero display types

Enumerator:
ZeroDisplayTypeZero 

zero

ZeroDisplayTypeDash 

dash

ZeroDisplayTypeEmpty 

empty

Member Function Documentation

int NXOpen::Annotations::TableCellStyleBuilder::BorderColor ( )

Returns the border color
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::TableCellStyleBuilder::BorderFont ( )

Returns the border font
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::TableCellStyleBuilder::BorderLocationType NXOpen::Annotations::TableCellStyleBuilder::BorderLocation ( )

Returns the border location
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::TableCellStyleBuilder::BorderWidth ( )

Returns the border width
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::TableCellStyleBuilder::FormatType NXOpen::Annotations::TableCellStyleBuilder::Format ( )

Returns the cell format
Created in NX8.0.0.



License requirements : None

std::vector<NXOpen::Annotations::TableCellStyleBuilder::FitMethodType> NXOpen::Annotations::TableCellStyleBuilder::GetFitMethods ( )

Returns the fit methods.

Returns

Created in NX8.0.0.

License requirements : None
bool NXOpen::Annotations::TableCellStyleBuilder::IncrementIsPercentage ( )

Returns the increment as percent flag
Created in NX8.0.0.



License requirements : None

double NXOpen::Annotations::TableCellStyleBuilder::IncrementValue ( )

Returns the increment value
Created in NX8.0.0.



License requirements : None

bool NXOpen::Annotations::TableCellStyleBuilder::IsAFormula ( )

Returns the is a formula
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::TableCellStyleBuilder::Precision ( )

Returns the precision
Created in NX8.0.0.



License requirements : None

NXString NXOpen::Annotations::TableCellStyleBuilder::Prefix ( )

Returns the prefix
Created in NX8.0.0.



License requirements : None

bool NXOpen::Annotations::TableCellStyleBuilder::ProtectCell ( )

Returns the protect cell
Created in NX9.0.0.



License requirements : None

void NXOpen::Annotations::TableCellStyleBuilder::SetAFormula ( bool  isAFormula)

Sets the is a formula
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
isAFormulaisaformula
void NXOpen::Annotations::TableCellStyleBuilder::SetBorderColor ( int  borderColor)

Sets the border color
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
borderColorbordercolor
void NXOpen::Annotations::TableCellStyleBuilder::SetBorderFont ( int  borderFont)

Sets the border font
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
borderFontborderfont
void NXOpen::Annotations::TableCellStyleBuilder::SetBorderLocation ( NXOpen::Annotations::TableCellStyleBuilder::BorderLocationType  borderLocation)

Sets the border location
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
borderLocationborderlocation
void NXOpen::Annotations::TableCellStyleBuilder::SetBorderWidth ( int  borderWidth)

Sets the border width
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
borderWidthborderwidth
void NXOpen::Annotations::TableCellStyleBuilder::SetFitMethods ( const std::vector< NXOpen::Annotations::TableCellStyleBuilder::FitMethodType > &  fitMethods)

Set fit methods
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
fitMethodsfitmethods
void NXOpen::Annotations::TableCellStyleBuilder::SetFormat ( NXOpen::Annotations::TableCellStyleBuilder::FormatType  format)

Sets the cell format
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
formatformat
void NXOpen::Annotations::TableCellStyleBuilder::SetIncrementIsPercentage ( bool  incrementValue)

Sets the increment as percent flag
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
incrementValueincrementvalue
void NXOpen::Annotations::TableCellStyleBuilder::SetIncrementValue ( double  incrementValue)

Sets the increment value
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
incrementValueincrementvalue
void NXOpen::Annotations::TableCellStyleBuilder::SetPrecision ( int  precision)

Sets the precision
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
precisionprecision
void NXOpen::Annotations::TableCellStyleBuilder::SetPrefix ( const NXString prefix)

Sets the prefix
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
prefixprefix
void NXOpen::Annotations::TableCellStyleBuilder::SetPrefix ( const char *  prefix)

Sets the prefix
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
prefixprefix
void NXOpen::Annotations::TableCellStyleBuilder::SetProtectCell ( bool  protectCell)

Sets the protect cell
Created in NX9.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
protectCellprotectcell
void NXOpen::Annotations::TableCellStyleBuilder::SetSlantAngle ( double  slantAngle)

Sets the slant angle in degrees
Created in NX8.5.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
slantAngleslantangle
void NXOpen::Annotations::TableCellStyleBuilder::SetSuffix ( const NXString suffix)

Sets the suffix
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
suffixsuffix
void NXOpen::Annotations::TableCellStyleBuilder::SetSuffix ( const char *  suffix)

Sets the suffix
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
suffixsuffix
void NXOpen::Annotations::TableCellStyleBuilder::SetTabDirection ( NXOpen::Annotations::TableCellStyleBuilder::TabDirectionType  tabDirection)

Sets the tab direction
Created in NX9.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
tabDirectiontabdirection
void NXOpen::Annotations::TableCellStyleBuilder::SetTextAlignment ( NXOpen::Annotations::TableCellStyleBuilder::TextAlignmentType  textAlignment)

Sets the text alignment
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
textAlignmenttextalignment
void NXOpen::Annotations::TableCellStyleBuilder::SetUrl ( const NXString url)

Sets the url
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
urlurl
void NXOpen::Annotations::TableCellStyleBuilder::SetUrl ( const char *  url)

Sets the url
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
urlurl
void NXOpen::Annotations::TableCellStyleBuilder::SetZeroDisplay ( NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplayType  zeroDisplay)

Sets the zero display
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
zeroDisplayzerodisplay
double NXOpen::Annotations::TableCellStyleBuilder::SlantAngle ( )

Returns the slant angle in degrees
Created in NX8.5.0.



License requirements : None

NXString NXOpen::Annotations::TableCellStyleBuilder::Suffix ( )

Returns the suffix
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::TableCellStyleBuilder::TabDirectionType NXOpen::Annotations::TableCellStyleBuilder::TabDirection ( )

Returns the tab direction
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::TableCellStyleBuilder::TextAlignmentType NXOpen::Annotations::TableCellStyleBuilder::TextAlignment ( )

Returns the text alignment
Created in NX8.0.0.



License requirements : None

NXString NXOpen::Annotations::TableCellStyleBuilder::Url ( )

Returns the url
Created in NX8.0.0.



License requirements : None

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

NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplayType NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplay ( )

Returns the zero display
Created in NX8.0.0.



License requirements : None


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