Represents a template for publishing a document. A publish template is an XML document that contains information used to automate the selection of options for a publishing request. For example, it contains the properties and security to apply to the destination document, and instructions for republishing a document, such as whether to version the existing destination document or replace it. Also, a publish template's StyleTemplate property might reference a PublishStyleTemplate object, which describes how the document is to be transformed.

Because IPublishTemplate extends the IDocument interface, you can work with a publish template in the same way you work with a document. For example, you can version a publish template, file it into a folder, and delete it. Publish templates are usually authored in the Publishing Designer application. However, you can override certain publish options when you call the Publish or Republish method. See Publish Options XML for more information.


The following tables list the members exposed by IPublishTemplate.

Public Properties

 NameDescription
Public propertyDescriptionSpecifies a string that describes this object.
Public propertyStyleTemplateContains a reference to the PublishStyleTemplate object associated with this publish template. If this property is null, then the publish template is for a copy operation; otherwise, it's for a transformation operation. The PublishStyleTemplate object's OutputFormat property will determine the type of transformation (for example, HTML or PDF).
Top

Public Methods

 NameDescription
Public methodAccessContentStreamObtains read access, via an input stream, to the content data of this ContentTransfer object. If content data is not present in the object’s property cache, it will be fetched from the server. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data.
Top

See Also