Property-Set-HTML method
Use this method to save the contents of an HTML stream as the value of a
Single Value
property. The property value can then be mapped as output for
transmission to an external system.
This method sets the results of stream processing on an HTML rule, after all directives are processed, as the value of the property specified.
For example, if your application uses a Service Email rule ( Rule-Service-Email rule type) to respond to an incoming email message, the response mapping can return an HTML-formatted email message containing clipboard values and HTML markup.
Don't attempt to set the value of a property that has a name starting with pz; these are reserved. Don't use this method for a property that is the target property of a Declare Expression rule.
Parameters
This method has two parameters:
| Parameter | Description |
|---|---|
| PropertyName |
Enter a
Single Value
target property reference. Identify the
property that is to receive its value from
stream
processing. Typically, choose a property that has a
Text
type.
|
| HTMLStream | Enter the Stream Name key part of an HTML rule ( Rule-Obj-HTML rule type) to be processed to produce the value of the property. |
Results
This method forms a key to an HTML rule from the value you supply for the second parameter and the class of the step page or of the activity. It uses rule resolution to find the HTML rule.
If the step page does not exist, a new page is created, of the class identified in the Pages & Classes tab.
It then uses stream processing to interpret and evaluate the directives (including property references) in this rule. It stores the resulting HTML text as the value of the property identified in the first parameter.
If the Type of the expression doesn't match the Type of the destination, the value is converted following the same scheme as within expressions. See Data type conversions (casting) in expressions and property assignments.
Any property messages previously associated with the property are cleared. The property value is validated against the property rule.
Cautions
- You can't use this method for a property that is also the target property of a Declare Expression rule. You can't save the Activity form if such a conflict is detected.
- Don't attempt to set the value of a property that has a name starting with pz; changes to such properties are reserved.
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.