Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
///
READ permission on the category is required.
[This is preliminary documentation and is subject to change.]
Reads the pdf-related properties for a category.
Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetCategoryProperties( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - categoryId
- Type: ContentStudio.DocumentCategoryId
The category to get properties for.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <data> <destinationcategoryid>293</destinationcategoryid> <destinationcategoryname>Namn</destinationcategoryname> <notiftype>1</notiftype> <notifwhen>3</notifwhen> <enabled>1</enabled> <allowcustomdata>0</allowcustomdata> <autoarchive>0</autoarchive> <optionsxml></optionsxml> <footerxml></footerxml> </data> </root>
This xml has the following members
| element | Description |
|---|---|
| root/status | The outcome of the call - always 0 (success) |
| root/statustext | The textual outcome of the call - always "Success" |
| root/data | Represents the returned item and its data nodes |
| root/data/documentid | Integer: The document to use as source of the Pdf. |
| root/data/destinationcategoryid | Integer: An identifier to the category where the generated Pdf should be uploaded to. |
| root/data/destinationcategoryname | String: The name of the category indicated by root/data/destinationcategoryid. |
| root/data/notiftype | Integer value: one of the values in the NotificationType enumeration |
| root/data/notifwhen | Integer flag value: A combination of the members in the PDFNotificationWhen enumeration.d |
| root/data/enabled | Bit value (0 or 1), true (1) if pdf generation is enabled; otherwise, false (0). |
| root/data/allowcustomdata | Bit value (0 or 1), When true (1) the user generating the pdf can set her own preferences. |
| root/data/autoarchive | Bit value (0 or 1), indicates whether to archive older versions of this pdf. |
| root/data/optionsxml | String: An embedded xml document that specifies how the pdf should be rendered. See below for a description of this xml. |
| root/pdfitem/footerxml | String: An embedded xml document that contains the footer settings to use. See below for a description of this xml. |
Xml returned in the optionsxml element
optionsxml
<root> <author>No author</author> <keywords>keyword</keywords> <subject>No subject</subject> <papersize>9</papersize> <orientation>1</orientation> <printquality>4</printquality> <printresolution>300</printresolution> <resolution>300</resolution> <truetypeoption>2</truetypeoption> <scaling>100</scaling> <leftmargin>10</leftmargin> <rightmargin>10</rightmargin> <topmargin>10</topmargin> <bottommargin>10</bottommargin> <waitbeforeprint>2</waitbeforeprint> <domain>.</domain> <timeout>60</timeout> <printertimeout>120</printertimeout> <totaltimeout>60</totaltimeout> <colorimageflags /> <colorimageresolution>600</colorimageresolution> <ieheader></ieheader> <iefooter></iefooter> </root>
this xml has the following elements and meaning
| element | Description |
|---|---|
| root/author | String: The author of the document |
| root/keywords | String: A list of keywords to use |
| root/subject | String: The document title (subject) |
| root/papersize |
Integer: a value that specifies the paper size to use.
|
| root/orientation |
Integer: The orientation of the page.
Can be one of the values
|
| root/printquality |
Integer: a value that indicates the quality requested. One of the following values.
|
| root/printresolution | Integer: A value (in dpi) that specifies the printer resolution. |
| root/resolution | Integer: A value (in dpi) that specifies the resolution. |
| root/truetypeoption | Integer: 2. |
| root/scaling | Integer: a value (in percent) that specifies how the pdf is scaled. |
| root/leftmargin | Integer: a value that specifies (in mm) the left margin of the generated Pdf. |
| root/rightmargin | Integer: a value that specifies (in mm) the right margin of the generated Pdf. |
| root/topmargin | Integer: a value that specifies (in mm) the top margin of the generated Pdf. |
| root/bottommargin | Integer: a value that specifies (in mm) the bottom margin of the generated Pdf. |
| root/waitbeforeprint | Integer: A value (in seconds) for the Pdf Server to wait before it starts printing the pdf. |
| root/domain | String: |
| root/timeout | Integer: A value (in seconds) that specifies general time out value. |
| root/printertimeout | Integer: A value (in seconds) that specifies the pdf printer time out. |
| root/colorimageflags | Integer: |
| root/colorimageresolution | Integer: A value (in dpi) specifying the printer color resolution. |
| root/ieheader | String: |
| root/iefooter | String: |
Xml returned in the footerxml element
footerxml
<root> <usefooter>1</usefooter> <startfrompage>1</startfrompage> <startnumber>1</startnumber> <createcontext></createcontext> <includecontextinnumbering></includecontextinnumbering> <footertext>Page $currentpage of $totalpages</footertext> <footerleft>10</footerleft> <footertop>7</footertop> <footerwidth>100</footerwidth> <htmlfont_normal></htmlfont_normal> <htmlfont_bold></htmlfont_bold> <htmlfont_italic></htmlfont_italic> </root>
this xml has the following elements and meaning
| element | Description |
|---|---|
| root/usefooter | Bit value (0 or 1), true (1) to include a page footer with each generated Pdf page; otherwise, false(0). |
| root/startfrompage | Integer: The page to start numbering from. 1 is the very first page in the generated Pdf. |
| root/startnumber | Integer: The value of the first page number to write. |
| root/createcontext | Bit value (0 or 1), true (1) if the Pdf server should create a context (index) page; otherwise, false |
| root/includecontextinnumbering | Bit value (0 or 1), true (1) to have the Pdf server to include context numbering. |
| root/footertext | String: The text to display as the footer. Depending on the actual Pdf server implementation this text can contain markings that the Pdf server replaces with actual values ex. Page $currentpage of $totalpages might be replaced with the text Page 3 of 45 on page number 3 of a total of 45 pages. It is up to the actual Pdf server implementation to define the actual markers to use. |
| root/footerleft | Integer: the bottom margin (in mm) of the page footer. |
| root/footertop | Integer: the top margin (in mm) of the page footer. |
| root/footerwidth | Integer: the width (in mm) of the page footer. |
| root/htmlfont_normal | String: The font to use for normal page footer text. |
| root/htmlfont_bold | String: The font to use for bold page footer text. |
| root/htmlfont_italic | String: The font to use for italic page footer text. |
Exceptions
| Exception | Condition |
|---|---|
| CSException | A business rule was violated in the underlying Content Studio database |
| CSPermissionDeniedException | The caller has no permission to perform the requested action |
| CSInvalidSessionException | The session is invalid |
| SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also