Format - property of the PmfString object

Description:

The property returns or sets the format of the value that will be displayed in the object.

Syntax:

Variant Format

Values:

Object data type - Reference to the PmFormat object.
This object enables formatting of the PmfString object value according to the specified format.

String data type - PmFormat object formatting string.
Creates the PmFormat object from the format string and enables formatting of the PmfString object value according to the specified format.

null data type - The PmFormat object is not set.
The value of the PmfString object will not be formatted.

Note:

Property access for read and write.

This property is also functional in Web panels.
The formatting string can also be entered in the sProps parameter of the CreateItem method.
Not all format string keys are supported at this moment - for example the keys LTxt:ss and RTxt:ss.

Example:

JavaScriptSelect and copy to clipboard



oString.Format = Pm.CreatePmFormat("Type:String;Case:1;");
  // Writing into the property

oString.Format = "Type:String;Case:1;";
  // Writing into the property

var oFormat = oString.Format;
  // Reading from the property

oString.Format = null;
  // Cancels the formatting of the value of the PmfString object