<< Return to Main Index

< Return to Class Index

CGXStyle Class Members

Construction

CGXStyle Constructs a style object.

Operations

operator= Copies the style or sets the value string.
SetDefault Initializes the default settings.
IsSubSet Checks if the specified style is a subset of the style.
ChangeStyle Applies another style to the style. Following operations are supported: gxOverride, gxApplyNew, gxCopy or gxRemove.
LoadBaseStyle Applies new base style settings to the style.
Free Resets all attributes in the style object.

Persistence

ReadProfile Reads the style from the profile.
WriteProfile Writes the style to the profile.
Serialize Serializes the style.

Value

SetValueType Sets the value type. Possible types are: GX_VT_STRING, GX_VT_NUMERIC, GX_VT_EXPRESSION and GX_VT_ERROR.
GetValueType Returns the value type.
GetIncludeValue Determines whether value is initialized.
SetIncludeValue Marks value as initialized or uninitialized.
GetValue Returns the value string.
GetValueRef Returns a reference to the value string.
SetValue Initializes the value string.
GetDWordValue Returns the value as DWORD.
GetWordValue Returns the value as WORD.
GetUIntValue Returns the value as UINT.
GetShortValue Returns the value as short.
GetLongValue Returns the value as LONG.
GetFloatValue Returns the value as float.
GetDoubleValue Returns the value as double.

Number formatting

GetIncludeFormat Determines whether number formatting has been set for this cell.
SetIncludeFormat Specifies number formatting as initialized or uninitalized.
GetFormat Returns the number formatting for the cell.
SetFormat Initializes the number formatting for this cell.
GetIncludePlaces Determines whether the number of places has been specified for this cell.
SetIncludePlaces Specifies number of places as initialized or uninitalized.
GetPlaces Returns the number of places for this cell.
SetPlaces Initializes the number of places for this cell. This number may have different meanings based depending on the format type.
GetIncludeNegativeZeroFlag Determines whether the boolean value of NegativeZeroFlag has been specified for this cell.
SetIncludeNegativeZeroFlag Specifies NegativeZeroFlag as initialized or uninitalized.
GetNegativeZeroFlag Returns the boolean value of NegativeZeroFlag for this cell.
SetNegativeZeroFlag Specifies whether the all-zero number being displayed is negative or positive.

User-defined attributes

GetIncludeUserAttribute Returns whether the specified attribute has been initialized.
SetIncludeUserAttribute Specifies whether the specified attribute should be marked as initialized.
GetUserAttribute Returns a CString or CGXAbstactUserAttribute with the value for the specified attribute.
SetUserAttribute Specifies the value for the specified attribute and marks it as initialized.

Predefined attributes

GetIncludeAllowEnter Determines whether allow enter is initialized.
SetIncludeAllowEnter Marks allow enter as initialized or uninitialized.
GetAllowEnter Returns the allow enter setting.
SetAllowEnter Initializes the allow enter setting.
GetIncludeAutoSize Determines whether auto-size is initialized
SetIncludeAutoSize Marks auto-size as initialized or uninitialized.
GetAutoSize Returns the auto-size state.
SetAutoSize Initializes the auto-size state.
GetIncludeBaseStyle Determines whether base style is initialized.
SetIncludeBaseStyle Marks base style as initialized or uninitialized.
GetBaseStyle Returns the base style id.
SetBaseStyle Initializes the base style setting.
GetIncludeBorders Determines whether border is initialized.
SetIncludeBorders Marks borders as initialized or uninitialized.
GetBorders Returns the pen object for the specified border.
GetBordersRef Returns a reference to the pen object for the specified border.
SetBorders Initializes the pen object for the specified border.
GetIncludeChoiceList Determines whether choice list is initialized.
SetIncludeChoiceList Marks choice list as initialized or uninitialized.
GetChoiceList Returns the choice list string.
GetChoiceListRef Returns a reference to the choice list string.
SetChoiceList Initializes the choice list string.
GetIncludeControl Determines whether control is initialized.
SetIncludeControl Marks control as initialized or uninitialized.
GetControl Returns the control setting.
SetControl Initializes the control setting.
GetIncludeDraw3dFrame Determines whether 3d effect is initialized.
SetIncludeDraw3dFrame Marks 3d effect as initialized or uninitialized.
GetDraw3dFrame Returns the 3d effect of the cell.
SetDraw3dFrame Initializes the 3d effect of the cell.
GetIncludeEnabled Determines whether enabled is initialized.
SetIncludeEnabled Marks enabled as initialized or uninitialized.
GetEnabled Returns the enabled setting.
SetEnabled Initializes the enabled setting.
GetIncludeFloatCell Determines if float cell attribute is initialized.
SetIncludeFloatCell Marks float cell attribute as initialized or not initialized.
GetFloatCell TRUE if floating the cell over other cells is allowed; FALSE otherwise.
SetFloatCell Allows or disallows cell to float over other cells.
GetIncludeFloodCell Determines if the flood cell attribute is initialized.
SetIncludeFloodCell Marks the flood cell attribute as initialized or not initialized.
GetFloodCell TRUE if hiding the cell by another floating cell is allowed; FALSE otherwise.
SetFloodCell Allows or disallows cell to be hidden by another floating cell.
GetIncludeFont Determines whether font is initialized.
SetIncludeFont Marks font as initialized or uninitialized.
GetFont Returns the font object.
GetFontRef Returns a reference to the font object.
SetFont Initializes the font object.
GetIncludeHorizontalAlignment Determines whether horizontal alignment is initialized.
SetIncludeHorizontalAlignment Marks horizontal alignment as initialized or uninitialized.
GetHorizontalAlignment Returns the horizontal alignment setting.
SetHorizontalAlignment Initializes the horizontal alignment setting.
GetIncludeInterior Determines whether interior is initialized.
SetIncludeInterior Marks interior as initialized or uninitialized.
GetInterior Returns the interior brush.
GetInteriorRef Returns a reference to the interior brush.
SetInterior Initializes the interior brush.
GetIncludeMaxLength Determines whether maximal length is initialized.
SetIncludeMaxLength Marks maximal length as initialized or uninitialized.
GetMaxLength Returns the maximal length setting.
SetMaxLength Initializes the maximal length setting.
GetIncludeMergeCell Determines if merge cell attribute is initialized.
SetIncludeMergeCell Marks merge cell attribute as initialized or not initialized.
GetMergeCell Determines how neighboring cells can be merged.
SetMergeCell Specifies how neighboring cells can be merged.
GetIncludeNegativeStateColor Determines whether NegativeStateColor is initialized
SetIncludeNegativeStateColor Mark NegativeStateColor as initialized or uninitialized
GetNegativeStateColor Returns the NegativeStateColor setting
SetNegativeStateColor Initializes the NegativeStateColor
GetIncludeReadOnly Determines whether read only is initialized.
SetIncludeReadOnly Marks read only as initialized or uninitialized.
GetReadOnly Returns the read only setting.
SetReadOnly Initializes the read only setting.
GetIncludeTextColor Determines whether textcolor is initialized.
SetIncludeTextColor Marks textcolor as initialized or uninitialized.
GetTextColor Returns the textcolor setting. If it is a system color (e.g., SYSCOLOR_WINDOWTEXT), the actual system setting will be returned.
GetTextColorNA Returns the textcolor setting. System colors will not be converted.
SetTextColor Initializes the textcolor setting. You might pass a system color by using the GXSYSCOLOR macro, as for example GXSYSCOLOR( SYSCOLOR_WINDOWTEXT ).
GetIncludeTriState Determines whether tri state is initialized.
SetIncludeTriState Marks tri state as initialized or uninitialized.
GetTriState Returns the tri state.
SetTriState Initializes the tri state.
GetIncludeVerticalAlignment Determines whether vertical alignment is initialized.
SetIncludeVerticalAlignment Marks vertical alignment as initialized or uninitialized.
GetVerticalAlignment Returns the vertical alignment setting.
SetVerticalAlignment Initializes the vertical alignment setting.
GetIncludeVertScrollBar Determines whether vertical scrollbar is initialized.
SetIncludeVertScrollBar Marks vertical scrollbar as initialized or uninitialized.
GetVertScrollBar Returns the vertical scrollbar setting.
SetVertScrollBar Initializes the vertical scrollbar setting.
GetIncludeWrapText Determines whether wrap text is initialized.
SetIncludeWrapText Marks wrap text as initialized or uninitialized.
GetWrapText Returns the wrap text setting.
SetWrapText Initializes the wrap text setting.
GetIncludeItemDataPtr Determines whether a user-defined item data pointer is initialized.
SetIncludeItemDataPtr Marks a user-defined item data pointer as initialized or uninitialized.
GetItemDataPtr Returns the user-defined item data pointer.
SetItemDataPtr Initializes the user-defined item data pointer.

Control Factory

ImplementCompareSubset Select "CGXStyle::IsSubset API" in Factory Wizard if you want to call CGXStyle::IsSubset in your project.
ImplementSerialize Select "CGXStyle::Serialize API" in Factory Wizard if you have disabled "Serialization" and "StyleDataExchange" and you want to programmatically call CGXStyle::Serialize..
ImplementSerializeOG5Compatible Select "SerializeOG5Compatible" in Factory Wizard if you want to read serialized documents created with OG 5.0 or earlier.
ImplementProfile Select "Profile" in Factory Wizard for reading and writing CGXProperties, CGXStyle, CGXFont and CGXStylesMap objects to the registry.

CGXStyle

Class Overview