Created 2008-04-11 08:09:37 by Nils G. Svedmyr on NILSXP [ Header and license information ]
Class List
Class cReportControlGridItem
Source: CREPORTCONTROLGRIDITEM.PKG
Baseclass: cComReportRecordItem
*** For Internal usage ***
Subclass (wrapper) for the ReportRecordItem class.
This is one item/cell in the grid (a cReportControlGrid Object).
The class is used by the cReportControlGrid class.
NOTE: You would normally not instantiate this class. Instead
you would use the corresponding messages of the cReportControlGrid class,
with the 'Set/Get MessageName item iItem to ...' syntax.
The messages has been placed here as a 'safety precaution' only;
If the wrong syntax is used in a cReportControlGrid object,
when addressing an item/cell,
e.g. 'Set pbIsButton of hCell to True'
...intead of the correct syntax:
'Set pbIsButton item hCell to True',
it will still work...
Procedures
Functions
Value String sValue - Procedure Set
To set the value of an individual item/cell.
Syntax:
Set Value to "Some text"
Note:
We need to set two value here. The ComValue is the value to sort on
when the column header is clicked. The ComCaption is the value that is
passed to the OnClick event. This can be used to figure out which item/cell
was acted upon.
pbBold Boolean bState - Procedure Set
To set an item/cell text to bold.
FontWeight Integer iWeight - Procedure Set
To set an item/cell text to bold.
Note: This is the same as using the pbBold property.
To set an item to BoldFace set the Weight to > 400.
This is put here for legacy purposes.
ItemColor Integer iColor - Procedure Set
To Set the background color for an item/cell.
Syntax: Set ItemColor to iColor
Constants:
clNone, clAqua, clBlack, clBlue, clDkGray, clFuchsia, clGray, clGreen, clLime, clLtGray,
clMaroon, clNavy, clOlive, clPurple, clRed, clSilver, clTeal, clWhite, clYellow
Note: You can also use the VDF RGB function to specify a color.
ItemTextColor Integer iColor - Procedure Set
Set the text or foreground color for an item/cell.
Syntax: Set ItemTextColor to iColor
Constants:
clNone, clAqua, clBlack, clBlue, clDkGray, clFuchsia, clGray, clGreen, clLime, clLtGray,
clMaroon, clNavy, clOlive, clPurple, clRed, clSilver, clTeal, clWhite, clYellow
Note: You can also use the VDF RGB function to specify a color.
Icon Integer iIcon - Procedure Set
To set an icon for a item/cell in the grid.
Syntax: Set Icon item iItem to RO_ButtonNormal
Params:
iIcon is the icon number in an ImageList
ToolTip String sToolTip - Procedure Set
Set the tooltip for an item/cell
Set ToolTip to "Item tooltip text"
Entry_State Boolean bState - Procedure Set
Determines if an item/cell can be edited.
Note: There are actually three different levels that can be used to
regulate if items/cells can be edited or not.
1. Set pbAllowEdit at grid level (global for the entire grid)
2. 'Set ColumnEntry_State item iColumn to True/FALSE' at column
level will override the pbAllowEdit setting.
3. 'Set Entry_State to True/FALSE' at item
level will override both the pbAllowEdit and Entry_State
setting at column level.
Syntax:
Set Entry_State to True/False
pbIsButton Boolean bState - Procedure Set
Should an item/cell be treated as a button?
Syntax:
Set pbIsButton to True/False
Note: The enum_list's RO_ButtonNormal and RO_ButtonPressed
icons will be used to display the button in an item.
Syntax: Set pbIsButton item iItem to True/FALSE
If the ReportRecordItem does not have a CheckBox, then setting the ComChecked
property has no effect. However, we can still set this property for our own usage,
namely to keep track of that this is a button item/cell.
Checkbox_Item_State Boolean bState - Procedure Set
Allows any item to become a checkbox-type item.
Syntax:
Set Checkbox_Item_State to True/False
Checked_State Boolean bState - Procedure Set
Reflects whether this item/cell is checked.
Syntax:
Set Checked_State to True/False
Aux_Value String sValue - Procedure Set
Syntax:
Set Aux_Value to sValue
You may use it to store any value you might wish to have associated with the item.
Value Returns String - Function
Syntax:
Get Value to sString
pbBold Returns Boolean - Function
To get if an item/cell text is bold or not.
FontWeight Integer iItem Returns Integer - Function
To get if an item/cell text is bold or not.
Returns:
Integer. If a value of 700 is returned the fontweight is bold.
Else if a value of 400 is returned the fontweight is not bold.
ItemColor Returns Integer - Function
Get the background color for an item/cell.
ItemTextColor Returns Integer - Function
Set the text color for an item/cell.
Syntax: Get ItemTextColor to Integer
Icon Returns Integer - Function
To Get an icon for a item/cell in the grid.
Syntax: Get Icon to iIconNumber
ToolTip Returns String - Function
Get the tooltip for an item/cell
Entry_State Returns Boolean - Function
Syntax: Get Entry_State to bState
pbIsButton Returns Boolean - Function
Is the item/cell a button?
Checkbox_Item_State Returns Boolean - Function
Is the item/cell a checkbox?
Syntax:
Get Checkbox_Item_State to bState
Checked_State Returns Boolean - Function
Is the item/cell checked?
Syntax:
Get Checked_State to bState
Aux_Value Returns String - Function
Syntax:
Get Aux_Value to sValue
Header and license information
****************************************************************************
$Module type: CLASS
$Module name: cReportControlGridColumn.pkg
$Author : Nils G. Svedmyr
Created : 2008-03-14 @ 17:59
Description : A wrapper class for the Report Control's ReportRecordItem.
The class is used internally by the class cReportControlGrid.
$Rev History
2008-03-14 Module header created
****************************************************************************
Note: If you don't have version 11.2.2 of the Report Control, you may use the 11.2.1 instead.
Of course you cannot Use both packages at the same time.
If you Use version 11.2.1 you wont be able to use the piWatermarkAlignment function
(If you have Set it in your code, it will be ignored.)
Use Codejock.ReportControl.v11.2.1.pkg