BBjGridHeader

Creation Path

BBjAPI > BBjSysGui > BBjWindow > BBjGrid > BBjGridHeader

 

Description

The BBjGridHeader is an object representation of a header of a BBjGrid.

Creation

A BBjGridHeader is obtained from a BBjGrid using one of the following methods of the BBjGrid:

Return Value

Method

BBjGridHeader

getRowHeader()

BBjGridHeader

getColumnHeader()

Methods of BBjGridHeader

Return Value

Method

int

getCellAlignment(int p_index)

BBjColor

getCellBackColor(int p_index)

BBjColor

getCellForeColor(int p_index)

int

getCellStyle(int p_index)

string

getCellText(int p_index)

int

getDefaultAlignment()

int

getDefaultStyle()

int

getStringWidth(string p_string)

string

getToolTipText()

string

getToolTipText(int index)

void

setCellAlignment(int p_index, int p_alignment)

void

setCellBackColor(int p_index, BBjColor p_color)

void

setCellIcon(int imgList, int imgIndex, int p_index)

void

setCellForeColor(int p_index, BBjColor p_color)

void

setCellStyle(int p_index, int p_style)

void

setCellText(int p_index, string p_text)

void

setDefaultAlignment(int p_alignment)

void

setDefaultStyle(int p_style)

void

setToolTipText(string text)

void

setToolTipText(int index, string text)

Remarks

Except for the method getStringWidth() each of the methods of a BBjGridHeader is equivalent to a corresponding method of a BBjGrid.

So, for example:

   Grid!.setColumnHeaderCellForeColor(3, blue!)

   Grid!.setColumnHeaderCellText(5,"abc")

Is equivalent to:

   Header! = Grid!.getColumnHeader()

   Header!.setCellForeColor(3, blue!)

   Header!.setCellText(5, "abc")

Events

Callback Code

Object-oriented Event

Read Record Event

Code

ON_GRID_DOUBLE_CLICK

BBjGridDoubleClickEvent

DCLICKED Grid Notify Event

N (Notify code 3)

ON_GRID_MOUSE_DOWN

BBjGridMouseDownEvent

LCLICKED Grid Notify Event

N (Notify code 14)

ON_GRID_MOUSE_UP

BBjGridMouseUpEvent

LCLICKED Grid Notify Event

N (Notify code 14)

ON_GRID_RIGHT_MOUSE_DOWN

BBjGridRightMouseDownEvent

RCLICKED Grid Notify Event

N (Notify code 18)

ON_GRID_RIGHT_MOUSE_UP

BBjGridRightMouseUpEvent

RCLICKED Grid Notify Event

N (Notify code 18)

ON_GRID_UPDATE

BBjGridUpdateEvent

TABLEUPDATE Grid Notify Event

N (Notify code 22)

Constants

GRID_STYLE_BUTTON_UP

GRID_STYLE_BUTTON_DOWN

GRID_ALIGN_LEFT

GRID_ALIGN_RIGHT

GRID_ALIGN_CENTER

Constants inherited from BBjControl

See Also

BBjAPI()

BBj Object Variables

BBj Object Creation and Assignment

BBj Object Error Handling

BBj Object Operators

CALLBACK Verb - Register BBj Subroutine

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.