DiagramPdfSettingsBuilder
Methods
Author(System.String)
The author of the PDF document that will be visible in the PDF file metadata.
Parameters
value - System.String
The value for Author
Creator(System.String)
The creator of the PDF document.
Parameters
value - System.String
The value for Creator
Date(System.DateTime)
The date when the PDF document is created. Defaults to new Date().
Parameters
value - System.DateTime
The value for Date
FileName(System.String)
Specifies the file name of the exported PDF file.
Parameters
value - System.String
The value for FileName
ForceProxy(System.Boolean)
If set to true, the exported content is forwarded to the endpoint specified using the proxyURL setting, even if the browser supports saving of files in the user's local file system.
Parameters
value - System.Boolean
The value for ForceProxy
ForceProxy()
If set to true, the exported content is forwarded to the endpoint specified using the proxyURL setting, even if the browser supports saving of files in the user's local file system.
Keywords(System.String)
Specifies the keywords that will appear in the metadata of the exported PDF file.
Parameters
value - System.String
The value for Keywords
Landscape(System.Boolean)
If set to true, changes the document orientation to landscape. This property takes effect when pdf.paperSize is set.
Parameters
value - System.Boolean
The value for Landscape
Landscape()
If set to true, changes the document orientation to landscape. This property takes effect when pdf.paperSize is set.
Margin(System.Action)
Sets the paper margins. The value has to be an object containing top, left, right, and bottom numbers which specify the paper margins. If numbers are passed, they are assumed to be in points (pt). By using strings, you can specify the units. The supported units are mm, cm, in, and pt (default).
Parameters
configurator - System.Action<DiagramPdfMarginSettingsBuilder>
The configurator for the margin setting.
PaperSize(System.String)
Specifies the paper size of the PDF document. The default setting is auto and determines the paper size by content.The supported values are: A predefined size: A0-A10, B0-B10, C0-C10, Executive, Folio, Legal, Letter, Tabloid.; An array of two numbers specifying the width and height in points (1pt = 1/72in) or An array of two strings specifying the width and height in units. The supported units are mm, cm, in, and pt..
Parameters
value - System.String
The value for PaperSize
ProxyURL(System.String)
The URL of the server side proxy which will stream the file to the end user.When the browser is not capable of saving files locally, a proxy will be used. Such browsers are Internet Explorer version 9 (and older) and Safari. You are responsible for implementing the server-side proxy. The proxy receives a POST request with the following parameters in the request body: contentType - The MIME type of the file; base64 - The base-64 encoded file content or fileName - The file name, as requested by the caller.. The proxy is expected to return the decoded file with a set Content-Disposition header.You can see sample server proxy implementations here: Server Proxy Implementations.
Parameters
value - System.String
The value for ProxyURL
ProxyTarget(System.String)
A name or keyword indicating where to display the document returned from the proxy.If you want to display the document in a new window or an iframe, the proxy method has to set the Content-Disposition header of the response to inline; filename="<fileName.pdf>".
Parameters
value - System.String
The value for ProxyTarget
Subject(System.String)
Sets the subject of document, which will be shown in the PDF file metadata.
Parameters
value - System.String
The value for Subject
Title(System.String)
Sets the title of the document, which will be shown in the PDF file metadata.
Parameters
value - System.String
The value for Title