PDFQueueManagerSetCategoryPdfProperties Method (ConnectionId, SessionId, CategoryId, Boolean, CategoryId, NotificationType, PDFNotificationWhen, Boolean, Boolean, Boolean, String, String, PdfCategoryStatusFlags) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Sets Pdf related settings on a category. These are used as default values for pdf to generate if the caller does not supply her own setting during the create process.

Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public void SetCategoryPdfProperties(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	bool enabled,
	CategoryId destinationCategoryId,
	NotificationType notificationType,
	PDFNotificationWhen notificationWhen,
	bool allowCustomData,
	bool autoArchive,
	bool traverseTree,
	string queryStrings,
	string optionsXml,
	PdfCategoryStatusFlags flags


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: ContentStudio.DocumentCategoryId
The category to save data for
Type: SystemBoolean
Indicates whether the category is enabled for PDF generation or not.
Type: ContentStudio.DocumentCategoryId
A category that acts as destination category for created PDF documents. This category mus exists and must be of the binary file type.
Type: ContentStudio.NotificationsNotificationType
The type of notification to send.
Type: ContentStudio.PDFServicesPDFNotificationWhen
Indicates when a notification should be sent.
Type: SystemBoolean
Determines if the caller can add their own settings when creating the pdf or if she must use the default settings of the category.
Type: SystemBoolean
Reserved, currently not used, pass false
Type: SystemBoolean
Set to true to indicate that the pdf should be generated from the passed in document and all its child documents.
Type: SystemString
Query strings to pass along to the documents when browsing them. This parameter cannot exceed MAX_PDF_QUERYSTRING_LENGTH characters in length.
Type: SystemString
Xml that contains settings. This value cannot exceed MAX_PDF_OPTIONSXML_LENGTH characters in length not included the embedded footer xml element.

This xml is a combination of the footerxml and optionsxml data. See the remarks section for information on how this xml is combined

Type: ContentStudio.PDFServicesPdfCategoryStatusFlags
Additional flags used by the PDF server.

CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
ArgumentNullExceptionEither queryStrings or optionsXml was null.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

WriteContainer permission on the category is required.

Note to the xml based optionsXml parameter.

This xml is created by adding a new xml element to the options xml named footerxml. The value of this element is then the actual footerXml.

    <author>No author</author>
    <subject>No subject</subject>
    <colorimageflags />
      (Embedded footer xml)

For a detailed description of the optionsXml and footerXml see the GetCategoryProperties method

The footerXml and optionsXml is stored independently of each other in the database so before the data is stored in the database these two documents are extracted and parsed prior to the actual save operation.

See Also