CATIAApplicationFrame class CATExtIDlgTableViewModel

• SystemTS.IUnknown
• System.IDispatch
• System.CATBaseUnknown
• CATExtIDlgTableViewModel

Usage: you can derive this class.

public class CATExtIDlgTableViewModel

Adapter for the CATIDlgTableViewModel interface.

Role : Adapter for the CATIDlgTableViewModel interface.

To implement the interface CATIDlgTableViewModel for a class MyClass, write a class MyClassExtIDlgTableViewModel subclassed from CATExtIDlgTableViewModel and defined as an data extension of MyClass. MyClassExtIDlgTableViewModel may override various methods, but in most case there is nothing to do.

Constructor and Destructor Index

o CATExtIDlgTableViewModel(void)

Constructs the class.

o ~CATExtIDlgTableViewModel(void)

Method Index

o GetBackgroundColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)

Retrieves the cell background color for all cells of a given style
Role: Style possible value are : OK, Normal, Warning, Error, Highlight, SubHighlight input : Default color value ouput : new color value.

o GetBackgroundColor(CATBaseUnknown_var,CATString&,unsigned int&,unsigned int&,unsigned int&,unsigned int&)

Retrieves the cell background color for the cell defined by iLine, iColumn.

o GetBorderColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)

Retrieves the cell border color for all cells of a given style.

o GetEventPublisher(CATBaseUnknown**)

retrieves the Event publisher that dispatches the update events when the view needs to be updated.

o GetTextColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)

Retrieves the text color for all cells of a given style.

o GetTextColor(CATBaseUnknown_var,CATString&,unsigned int&,unsigned int&,unsigned int&,unsigned int&)

Retrieves the cell text color for the cell defined by iLine, iColumn.

o GetUpdateEvent(CATCallbackEvent*)

Retrieves the event dispatched by the model when the view needs to be updated.

o IsEditable(CATBaseUnknown_var&,CATString&,CATBoolean&)

Indicates if the pointed cell can be edited.

Constructor and Destructor

Constructs the class.

Methods

Retrieves the cell background color for all cells of a given style
Role: Style possible value are : OK, Normal, Warning, Error, Highlight, SubHighlight input : Default color value ouput : new color value. Leave value unchanged to keep default colors

Parameters:

iStyle

[in] The searched cell style. The possible values are:

• CATDlgTableLeftJustify |
• CATDlgTableRightJustify |- Horizontal cell alignement
• CATDlgTableCenterJustify |
• CATDlgTableTopJustify |
• CATDlgTableBottomJustify |- Vertical cell alignement
• CATDlgTableMiddleJustify |
• CATDlgTableCellOK | OK cell style
• CATDlgTableCellNormal | Normal cell style
• CATDlgTableCellWarning | Warning cell style
• CATDlgTableCellError | Error cell style
• CATDlgTableCellCustom | Custom cell style

ioRed

[inout] It defines the red component of the background color.The value ranges from 0 to 255.

ioGreen

[inout] It defines the green component of the background color.The value ranges from 0 to 255.

ioBlue

[inout] It defines the blue component of the background color.The value ranges from 0 to 255.

ioAlpha

[inout] Not supported.

Retrieves the cell background color for the cell defined by iLine, iColumn.
Role: This method is not called if the cells does not have the style CustomColor. input : Default color value ouput : new color value. Leave value unchanged to keep default colors

Parameters:

iLine

[in] The line containing the cell.

iColumnID

[in] ID of the column containing the cell.

ioRed

[inout] It defines the red component of the background color.The value ranges from 0 to 255.

ioGreen

[inout] It defines the green component of the background color.The value ranges from 0 to 255.

ioBlue

[inout] It defines the blue component of the background color.The value ranges from 0 to 255.

ioAlpha

[inout] Not supported.

Retrieves the cell border color for all cells of a given style.
Role: Retrieves the cell border color for all cells of given style. input : Default color value ouput : New color value. Leave value unchanged to keep default colors

Parameters:

iStyle

[in] The searched cell style. The possible values are:

• CATDlgTableLeftJustify |
• CATDlgTableRightJustify |- Horizontal cell alignement
• CATDlgTableCenterJustify |
• CATDlgTableTopJustify |
• CATDlgTableBottomJustify |- Vertical cell alignement
• CATDlgTableMiddleJustify |
• CATDlgTableCellOK | OK cell style
• CATDlgTableCellNormal | Normal cell style
• CATDlgTableCellWarning | Warning cell style
• CATDlgTableCellError | Error cell style
• CATDlgTableCellCustom | Custom cell style

ioRed

[inout] It defines the red component of the border color.The value ranges from 0 to 255.

ioGreen

[inout] It defines the green component of the border color.The value ranges from 0 to 255.

ioBlue

[inout] It defines the blue component of the border color.The value ranges from 0 to 255.

ioAlpha

[inout] Not supported.

retrieves the Event publisher that dispatches the update events when the view needs to be updated.
Role: retrieves the Event publisher that dispatches the update events when the view needs to be updated. The view subscribes to this publiser on the UpdateEvent.

Parameters:

oTableModelEventPublisher

[out] The event publisher that dispatches the update events.

Returns:

S_OK if everything ran ok.

Retrieves the text color for all cells of a given style.
Role: Retrieves the cell background color for all cells of given style. input : Default color value ouput : new color value. Leave value unchanged to keep default colors

Parameters:

iStyle

[in] The searched cell style. The possible values are:

• CATDlgTableLeftJustify |
• CATDlgTableRightJustify |- Horizontal cell alignement
• CATDlgTableCenterJustify |
• CATDlgTableTopJustify |
• CATDlgTableBottomJustify |- Vertical cell alignement
• CATDlgTableMiddleJustify |
• CATDlgTableCellOK | OK cell style
• CATDlgTableCellNormal | Normal cell style
• CATDlgTableCellWarning | Warning cell style
• CATDlgTableCellError | Error cell style
• CATDlgTableCellCustom | Custom cell style

ioRed

[inout] It defines the red component of the text color.The value ranges from 0 to 255.

ioGreen

[inout] It defines the green component of the text color.The value ranges from 0 to 255.

ioBlue

[inout] It defines the blue component of the text color.The value ranges from 0 to 255.

ioAlpha

[inout] Not supported.

Retrieves the cell text color for the cell defined by iLine, iColumn.
Role: Retrieves the cell text color for the cell defined by iLine, iColumn. This method is not called if the cells does not have the style CustomColor input : Default color value ouput : new color value. Leave value unchanged to keep default colors

Parameters:

iLine

[in] The line containing the cell. This data must be serializable.

iColumn

[in] ID of the column containing the cell.

ioRed

[inout] It defines the red component of the text color.The value ranges from 0 to 255.

ioGreen

[inout] It defines the green component of the text color.The value ranges from 0 to 255.

ioBlue

[inout] It defines the blue component of the text color.The value ranges from 0 to 255.

ioAlpha

[inout] Not supported

Returns:

S_OK if everything ran ok, otherwise...

Retrieves the event dispatched by the model when the view needs to be updated.
Role: Retrieves the event dispatched by the model when the view needs to be updated.

Parameters:

oUpdateEvent

[out] The event dispatched by the model

Returns:

S_OK if everything ran ok, E_FAIL otherwise.

Indicates if the pointed cell can be edited.
Role: Indicates if the pointed cell can be edited.

Parameters:

iLine

[in] The line containing the cell. This data must be serializable.

iColumn

[in] ID of the column containing the cell.

oEditable

[out] CATBoolean indicating the pointed cell's editability. Returns true if the cell can be edited by user

Returns:

S_OK if everything ran ok.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.