SetColumnFormat Method (LISTVIEW)


PLBCMP GUI Only

 

The SetColumnFormat method modifies a column's justification within a LISTVIEW object. The method uses the following format:

 

[label]

{object}.SetColumnFormat

[GIVING {return}] USING [*Index=]{index}:

 

 

[*Format=]{format}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is modified.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

index

Required. A decimal number or Numeric Variable that specifies the zero-based column to modify.

format

Required. A decimal number or Numeric Variable that specifies the new column format as described below.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The {format} value is a constant as defined in PLBMETH.INC or a numeric variable indicating one of the following label justifications:

  2.  

    Value

    Constant

    Meaning ...

    0x0

    LVCFMT_LEFT

    The column is left justified. (default)

    0x1

    LVCFMT_RIGHT

    The column is right justified.

    0x2

    LVCFMT_CENTER

    is centered.

    0x100

    LVCFMT_FIXED_WIDTH

    The column is not resizable. (Version 6.00 and Windows Vista)

    0x800

    LVCFMT_IMAGE

    The column displays an image from an imagelist. (Version 4.70).

    0x1000

    LVCFMT_BITMAP_ON_RIGHT

    The column displays a bitmap image to the right of the text. (Version 4.70)

    0x8000

    LVCFMT_COL_HAS_IMAGES

    The header item contains an image in the imagelist. (Version 4.70)

    0x40000

    LVCFMT_NO_DPI_SCALE

    If not set, CCM_DPISCALE will govern scaling up fixed width. (Version 6.00 and Windows Vista)

    0x80000

    LVCFMT_FIXED_RATIO

    Width will augment with the row height. (Version 6.00 and Windows Vista)

    0x100000

    LVCFMT_SPLITBUTTON

    Column is a split button. The header of the column displays a split button. (Version 6.00 and Windows Vista)

 

  1. The behavior associated with these {format} values depends on the version of the Windows components that are being used. For additional information, see the Microsoft documentation for the Windows LVM_INSERTCOLUMN or LVM_SETCOLUMN messages of a LISTVIEW control.

  2. The leftmost column in a list view control must be left-aligned.

  3. Upon completion, {return} will contain the status of the modification as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

  4.  

    Value

    Constant

    The modification ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

 

  1. If the value returned is zero, the ZERO Condition Flag is set.

  2. The OVER and EOS Condition Flags are always cleared.

  3. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference SetColResizeFlag (LISTVIEW) SetColumnImage Method (LISTVIEW)