Method Xbp3State():new()

Creates an instance of the Xbp3State class.

Xbp3State():new( [<oParent>], ;
                 [<oOwner>], ;
                 [<aPos>], ;
                 [<aSize>], ;
                 [<aPresParam>], ;
                 [<lVisible>] ) --> oXbp3StateButton

The parent for an Xbp3State object can be optionally specified using the parameter <oParent>. By default <oParent> is the active window (the return value of SetAppWindow()). If the default is used, the active window must be an XbpCrt window. If the active window is an XbpDialog window, the drawing area of the window must be specified for <oParent>. The drawing area is referenced using the instance variable oXbpDialog:drawingArea.

<oOwner> can be used to set the owner for the Xbp3State object. By default <oOwner> is the same as <oParent>.

<aPos> := { nX, nY }

The optional parameter <aPos> can be used to specify the position where the Xbp3State object is displayed. By default, this parameter contains the array {0,0}. This specifies the position for the lower left corner of the Xbp3State object. The first element contains the x coordinate and the second contains the y coordinate. The coordinates are relative to the coordinate system of <oParent>.

<aSize> := { nXsize, nYsize }

The parameter <aSize> optionally specifies the size of the Xbp3State object. <aSize> must be an array containing two elements. The first element specifies the dimension in the x direction (width) and the second element specifies the dimension in the y direction (height). By default this value is the array {0,0}.

A two dimensional array can be specified for <aPresParam>. Refer to Generic presentation parametersfor a detailed explanation.

The parameter <lVisible> determines whether the Xbp3State object is visible immediately after the call to the method :create(). By default <lVisible> is .T. (true) and the Xbp3State object is displayed after :create() is executed. This default behavior can be suppressed by specifying the value .F. (false) for the parameter <lVisible>. In this case, the Xbp3State object must be explicitly displayed using the :show() method.

The class method :new() returns an Xbp3State object.

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Method Xbp3State():new() Foundation