Represents the style template that defines how a source document will be transformed. A style template serves as a template for a particular kind of transformation and is tied to a specific publishing event handler on a specific object store. (Note that a publishing event handler can have more than one style template associated with it.)

Information in the style template can be whatever is meaningful to the publishing event handler. For example, the style template might include an XML-based description of the transformation to be done for this style template, an ID of another document that contains a more detailed template, or a URL for publishing to an external location. A style template also specifies a list of input formats (MIME types) supported for the style template, the output format (MIME type) generated when the style template is applied, and, optionally, passwords used by PDF renditions.

A publish style template associated with the HTML publishing event handler does not specify any additional transformation options beyond the basic ones (title, description, input formats, output format, and provider ID). In addition to the basic transformation options (as mentioned above for the HTML publishing event handler), a publish style template associated with the PDF publishing event handler optionally specifies the user and master PDF passwords, as well as other PDF security and watermark settings (stored as XML in the TransformationOptions property).


The following tables list the members exposed by IPublishStyleTemplate.

Public Properties

 NameDescription
Public propertyDescriptionSpecifies a string that describes this object.
Public propertyInputFormatsSpecifies a list of input document MIME types supported for this style template.
Public propertyOutputFormatSpecifies the MIME type of output documents produced by the transformation engine when using this style template (for example, "text/html").
Public propertyPDFMasterPasswordSpecifies an encrypted master password for a PDF rendition. Because this property contains a password, it can only be set. (Attempting to retrieve this property will return a zero-length binary value.)
Public propertyPDFUserPasswordSpecifies an encrypted user password for a PDF rendition. Because this property contains a password, it can only be set. (Attempting to retrieve this property will return a zero-length binary value.)
Public propertyProviderIDSpecifies an ID string that represents the Java™-based event handler associated with this publish style template (for example, PublishRequestHTMLHandler or PublishRequestPDFHandler).
Public propertyTitleSpecifies the title of this style template.
Public propertyTransformationOptionsSpecifies a binary-valued, publishing transformation handler-specific description of the transformation to be done for this style template. This could be an XML-based description or the ID of another document that contains a more detailed template. For publishing to an external location, the publishing transformation handler implementers could also have chosen to put a URL as part of this property's value.

The publish style templates associated with the PDF publishing event handler can optionally specify PDF security and watermark settings (stored as XML in the TransformationOptions property). The publish style templates associated with the HTML publishing event handler do not specify any settings in the TransformationOptions property.

Top

See Also