Arrange Method (LISTVIEW)


PLBCMP GUI Only

 

The Arrange method alters the position of items within a LISTVIEW object. The method uses the following format:

 

[label]

{object}.Arrange

[GIVING {return}] USING [*Code=]{code}

 

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.

code

Required. A decimal number or Numeric Variable that indicates an alignment from the table below.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The LISTVIEW must be in icon or small icon view.

  2. {code} is a constant as defined in PLBMETH.INC or a numeric variable indicating one of the following actions:
     

  3. Value

    Constant

    Arrange items …

    0x0

    LVA_DEFAULT

    using the current alignment.

    0x1

    LVA_ALIGNLEFT

    along the left of the list window.

    0x2

    LVA_ALIGNTOP

    along the top of the list window.

    0x5

    LVA_SNAPTOGRID

    to the closest grid position.

 

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

  2. Value

    Constant

    The arrangement ...

    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 Flags are always cleared.

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

  4. This method is not available when using the PL/B Web Server.

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference LISTVIEW Methods DeleteAllContents Method (LISTVIEW)