Properties Class Methods
In this section, the Properties class methods are presented in alphabetical order.
Syntax
GetProperty(Name, OutValue)
Description
Use the GetProperty method to return the value of the specified property.
Parameters
Field or Control |
Definition |
---|---|
Name |
Specify the name of the property that you want to access the value. |
OutValue |
Specify a string to contain the value of the property you want to access. |
Returns
A Boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.
Example
Local PSXP_ENGINE:Properties &oProp;
&oProp = create PSXP_ENGINE:Properties();
%sValue = "";
&bResult = &oProp.getProperty("pdf-security", %sValue);
Syntax
SetProperty(Name, Value)
Description
Use the SetProperty method to specify the value of the specified property.
Parameters
Field or Control |
Definition |
---|---|
Name |
Specify the name of the property that you want to set. |
Value |
Specify the value of the property that you want to set. |
Returns
A Boolean: true if the method completed successfully, false otherwise. If this method returns false, the Error parameter is populated with the text of the error message that occurred.
Example
Local PSXP_ENGINE:Properties &oProp;
&oProp = create PSXP_ENGINE:Properties();
&bResult = &oProp.setProperty("pdf-security", "true");