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

Represents a Annotations::TableCellStyleBuilder . More...

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

List of all members.

Public Types

enum  BorderLocationType {
  BorderLocationTypeAll, BorderLocationTypeLeft, BorderLocationTypeTop, BorderLocationTypeRight,
  BorderLocationTypeBottom, BorderLocationTypeMiddle, BorderLocationTypeCenter
}
 the valid border location types More...
enum  FormatType {
  FormatTypeText = 1, FormatTypeFloat, FormatTypeFixed, FormatTypeGeneral,
  FormatTypeMonetary, FormatTypeComma, FormatTypeFractionHalfSize, FormatTypeFractionThreeQuarterSize,
  FormatTypeFractionFullSize, FormatTypePercent, FormatTypeDegrees, FormatTypeHex,
  FormatTypeLogic, FormatTypeDateDmy, FormatTypeDateDm, FormatTypeDateMy,
  FormatTypeDateMdy, FormatTypeDateYmd, FormatTypeDateY4md, FormatTypeDateDmyDot,
  FormatTypeTimeHm, FormatTypeTimeHms, FormatTypeHidden, FormatTypeCustom
}
 the valid cell format types 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< int > 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.
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< int > &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 SetSuffix (const NXString &suffix)
 Sets the suffix
Created in NX8.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 SetZeroDisplay (NXOpen::Annotations::TableCellStyleBuilder::ZeroDisplayType zeroDisplay)
 Sets the zero display
Created in NX8.0.0.
NXString Suffix ()
 Returns the suffix
Created in NX8.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.

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 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

FormatTypePercent 

percent

FormatTypeDegrees 

degrees

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 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

Returns the border color
Created in NX8.0.0.



License requirements : None

Returns the border font
Created in NX8.0.0.



License requirements : None

Returns the border location
Created in NX8.0.0.



License requirements : None

Returns the border width
Created in NX8.0.0.



License requirements : None

Returns the cell format
Created in NX8.0.0.



License requirements : None

Returns the fit methods.

Returns:

Created in NX8.0.0.

License requirements : None

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



License requirements : None

Returns the increment value
Created in NX8.0.0.



License requirements : None

Returns the is a formula
Created in NX8.0.0.



License requirements : None

Returns the precision
Created in NX8.0.0.



License requirements : None

Returns the prefix
Created in NX8.0.0.



License requirements : None

Sets the is a formula
Created in NX8.0.0.



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

Parameters:
isAFormulaisaformula

Sets the border color
Created in NX8.0.0.



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

Parameters:
borderColorbordercolor

Sets the border font
Created in NX8.0.0.



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

Parameters:
borderFontborderfont

Sets the border location
Created in NX8.0.0.



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

Parameters:
borderLocationborderlocation

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< int > &  fitMethods)

Set fit methods
Created in NX8.0.0.



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

Parameters:
fitMethodsfitmethods

Sets the cell format
Created in NX8.0.0.



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

Parameters:
formatformat

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



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

Parameters:
incrementValueincrementvalue

Sets the increment value
Created in NX8.0.0.



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

Parameters:
incrementValueincrementvalue

Sets the precision
Created in NX8.0.0.



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

Parameters:
precisionprecision

Sets the prefix
Created in NX8.0.0.



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

Parameters:
prefixprefix

Sets the suffix
Created in NX8.0.0.



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

Parameters:
suffixsuffix

Sets the text alignment
Created in NX8.0.0.



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

Parameters:
textAlignmenttextalignment

Sets the url
Created in NX8.0.0.



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

Parameters:
urlurl

Sets the zero display
Created in NX8.0.0.



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

Parameters:
zeroDisplayzerodisplay

Returns the suffix
Created in NX8.0.0.



License requirements : None

Returns the text alignment
Created in NX8.0.0.



License requirements : None

Returns the url
Created in NX8.0.0.



License requirements : None

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.

Returns the zero display
Created in NX8.0.0.



License requirements : None


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