InsertColumnEx Method (LISTVIEW)


PLBCMP GUI Only

 

The InsertColumnEx method adds a new column into a LISTVIEW object. The method uses the following format:

 

[label]

{object}.InsertColumnEx

[GIVING {return}] USING [*Text=]{text}:

 

 

[*Width=]{width},[*Index=]{index}[:

 

 

[*Format=]{format}][,[*Image=]{image}][:

 

 

[*Order=]{order}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object into which a column is inserted.

return

Optional. A Numeric Variable that returns the new column number.

text

Required. A Character String Variable or literal that specifies the label for the new column.

width

Required. A decimal number or Numeric Variable that specifies the width of the new column in pixels.

index

Required. A decimal number or Numeric Variable that specifies the zero-based row of the sub item for the new column.

format

Optional. A decimal number or Numeric Variable that specifies the label justification as described below.

image

Optional. A decimal number or Numeric Variable that specifies the small image displayed in the column header.

order

Optional. A decimal number or Numeric Variable that specifies the order of the column.

Flags Affected: EOS, OVER, ZERO

Note the following:

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

  2.  

    Value

    Constant

    The column ...

    0x0

    LVCFMT_LEFT

    is left justified. (default)

    0x1

    LVCFMT_RIGHT

    is right justified.

    0x2

    LVCFMT_CENTER

    is centered.

    0x800

    LVCFMT_IMAGE

    has an image.

    0x1000

    LVCFMT_BITMAP_ON_RIGHT

    image should be displayed on the right.

    0x8000

    LVCFMT_COL_HAS_IMAGES

    has images.

 

  1. Upon completion, {return} will contain the new column number or -1 if the method fails.

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

  3. If {return} is too small to contain result of the method, the OVER Condition Flag is set.

  4. The EOS Condition Flag is always cleared.

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

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference InsertColumnBgClr Method (LISTVIEW) InsertColumnFgClr Method (LISTVIEW)