Publishes this Document object according to the specifications included in the specified
publish template as modified by the contents of the publishOptions parameter. This method
returns the PublishRequest object that is queued for this request. All publish requests are asynchronous,
including copy operations, which do not transform the document. A publish request is always enqueued, and
a copy of the PublishRequest object is always returned to the caller.
Namespace:
FileNet.Api.CoreThe publish template you specify, as well as any objects specified in the publish template itself, must reside on the same object store as this Document object. Note that publishing to a document class containing a required binary- or object-valued property is not supported as there is no way to set these property values during publishing.
The publishOptions parameter is a string containing XML that specifies the publish options for the published document. See Publish Options XML for more information.
After a successful call to publish, call the Save method of the returned PublishRequest object to submit the request to the publish queue.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Function Publish ( _ publishTemplate As IPublishTemplate, _ publishOptions As String _ ) As IPublishRequest |
C# |
---|
IPublishRequest Publish( IPublishTemplate publishTemplate, string publishOptions ) |
Visual C++ |
---|
IPublishRequest^ Publish( IPublishTemplate^ publishTemplate, String^ publishOptions ) |
JavaScript |
---|
function publish(publishTemplate, publishOptions); |
Parameters
- publishTemplate
- Type: FileNet.Api.Publishing..::.IPublishTemplate
The PublishTemplate object to use for this publish operation.
- publishOptions
- Type: System..::.String
A string containing XML that specifies the publish options for the published document. Can be null, in which case the values for the publication name, output folder, and event action are as specified in the associated publish template.