### Get ConversionStartOptions Source: https://api.docotic.com/htmltopdf/htmlconversionoptions-start Retrieves the options for the conversion start. This property is read-only. ```csharp public ConversionStartOptions Start { get; } ``` -------------------------------- ### ConversionStartMode Property Source: https://api.docotic.com/htmltopdf/conversionstartoptions-mode Gets the start mode for HTML to PDF conversion. The default value is OnLoad. ```APIDOC ## Property Mode ### Description Gets the start mode for HTML to PDF conversion. The default value is `OnLoad`. ### Property Value `ConversionStartMode` - The start mode. ### Remarks Default value: `OnLoad`. ``` -------------------------------- ### Get ConversionStartMode Source: https://api.docotic.com/htmltopdf/conversionstartoptions-mode Retrieves the current start mode for PDF conversion. The default value is OnLoad. ```csharp public ConversionStartMode Mode { get; } ``` -------------------------------- ### ConversionStartOptions() Source: https://api.docotic.com/htmltopdf/conversionstartoptions-ctor Initializes a new instance of the ConversionStartOptions class with default settings. ```APIDOC ## ConversionStartOptions() ### Description Initializes a new instance of the ConversionStartOptions class. ### Method Constructor ### Parameters None ### Response Initializes a new instance of the ConversionStartOptions class. ``` -------------------------------- ### Get PdfBezierSegment Start Point Source: https://api.docotic.com/pdfbeziersegment-start Retrieves the starting point of a PdfBezierSegment. This property is read-only. ```csharp public PdfPoint Start { get; } ``` -------------------------------- ### Get or Set StartNumber Property Source: https://api.docotic.com/pdfpagelabelingrange-startnumber Gets or sets the start number for the first page label in a range. Subsequent pages are numbered sequentially from this value. A value of 0 indicates the start number is not specified. ```csharp public int StartNumber { get; set; } ``` -------------------------------- ### ConversionStartOptions Methods Source: https://api.docotic.com/htmltopdf/conversionstartoptions Details the methods available for controlling the conversion start behavior. ```APIDOC ## SetStartAfterDelay(int delay) ### Description Switches to the AfterDelay mode and sets the amount of the delay. ### Method Method ### Parameters #### Path Parameters - **delay** (int) - Required - The amount of delay in milliseconds. ``` ```APIDOC ## SetStartAfterScriptRun(string script) ### Description Switches to the AfterScriptRun mode and sets the script to run. ### Method Method ### Parameters #### Path Parameters - **script** (string) - Required - The script to run before the conversion starts. ``` ```APIDOC ## SetStartOnLoad() ### Description Switches to the OnLoad mode. ### Method Method ### Parameters None ``` -------------------------------- ### Initialize ConversionStartOptions Source: https://api.docotic.com/htmltopdf/conversionstartoptions-ctor Initializes a new instance of the ConversionStartOptions class with default settings. ```csharp public ConversionStartOptions() ``` -------------------------------- ### PdfCloseSubpathSegment.Start Source: https://api.docotic.com/pdfclosesubpathsegment-start Gets the start point of this PdfCloseSubpathSegment. This property returns a PdfPoint object representing the starting coordinates of the subpath segment. ```APIDOC ## Start ### Description Gets the start point of this PdfCloseSubpathSegment. ### Property Value PdfPoint The start point of this PdfCloseSubpathSegment. ``` -------------------------------- ### Set Start Mode to On Load Source: https://api.docotic.com/htmltopdf/conversionstartoptions Switches the conversion start mode to 'OnLoad', initiating the conversion as soon as the HTML document is loaded. This is the default behavior if no other mode is specified. ```csharp options.SetStartOnLoad(); ``` -------------------------------- ### PdfBezierSegment.Start Source: https://api.docotic.com/pdfbeziersegment-start Gets the start point of this PdfBezierSegment. This property returns a PdfPoint object representing the starting coordinates of the Bezier segment. ```APIDOC ## Start ### Description Gets the start point of this PdfBezierSegment. ### Property Value PdfPoint The start point of this PdfBezierSegment. ``` -------------------------------- ### Initialize with Key Store File Source: https://api.docotic.com/pdfpublickeydecryptionhandler-ctor Create a decryption handler using a PFX or PKCS #12 key store file. Provide the path to the file and its password. A matching certificate in the store is required for decryption. ```csharp public PdfPublicKeyDecryptionHandler(string keyStorePath, string password)__ ``` -------------------------------- ### PdfPoint Value Property Source: https://api.docotic.com/pdfpointsegment-value Gets the start point of a subpath. This property returns a PdfPoint object representing the coordinates of the starting point. ```APIDOC ## PdfPoint Value Property ### Description Gets the start point of a subpath. ### Property `PdfPoint Value { get; }` ### Return Value PdfPoint The start point of a subpath. ``` -------------------------------- ### ConversionStartOptions Constructors Source: https://api.docotic.com/htmltopdf/conversionstartoptions Initializes a new instance of the ConversionStartOptions class. ```APIDOC ## ConversionStartOptions() ### Description Initializes a new instance of the ConversionStartOptions class. ### Method Constructor ### Parameters None ``` -------------------------------- ### TextPosition Property Source: https://api.docotic.com/pdfcanvas-textposition Gets or sets the current text position. Consecutive text-drawing operations that do not explicitly specify a start position will use this position as the start one. ```APIDOC ## Property TextPosition ### Description Gets or sets the current text position. Consecutive text-drawing operations that do not explicitly specify a start position will use this position as the start one. ### Property Value PdfPoint - The text position. ### Remarks Consecutive text-drawing operations that do not explicitly specify start position will use this position as the start one. ``` -------------------------------- ### Initialize with X509Store Source: https://api.docotic.com/pdfpublickeydecryptionhandler-ctor Create a decryption handler using a specified X509Store. The library searches this store for a matching certificate. Only exportable certificates are considered. ```csharp public PdfPublicKeyDecryptionHandler(X509Store store)__ ``` -------------------------------- ### Get PdfPoint Value Source: https://api.docotic.com/pdfpointsegment-value Retrieves the starting point of a subpath. This property is read-only. ```csharp public PdfPoint Value { get; } ``` -------------------------------- ### Create PdfSigningOptions with Key Store File Source: https://api.docotic.com/pdfsigningoptions-ctor Initializes PdfSigningOptions using a file path and password for a PFX or PKCS #12 key store. ```csharp public PdfSigningOptions(string path, string password)__ ``` -------------------------------- ### Offset Property Source: https://api.docotic.com/pdfdashpattern-offset Gets the distance from the start of a line to the beginning of the dash pattern. ```APIDOC ## Offset Property ### Description Gets the distance from the start of a line to the beginning of the dash pattern. ### Property Value `double` - The distance from the start of a line to the beginning of the dash pattern. ``` -------------------------------- ### Create PdfPublicKeyEncryptionHandler with Key Store Path and Permissions Source: https://api.docotic.com/pdfpublickeyencryptionhandler-ctor Use this constructor to create an encryption handler with specified permissions using a key store file. Requires the path to the PFX/PKCS #12 file, its password, and the desired permissions. ```csharp public PdfPublicKeyEncryptionHandler(string keyStorePath, string password, PdfPermissions permissions) ``` -------------------------------- ### Get or Set MappingName Source: https://api.docotic.com/pdfcontrol-mappingname Gets or sets the mapping name of the control. This name is used when exporting form data from the document, for example, PdfSubmitFormAction transmits MappingName instead of Name. ```csharp public string? MappingName { get; set; } ``` -------------------------------- ### ConversionStartOptions Source: https://api.docotic.com/htmltopdf/bitmiracle-docotic-pdf-htmltopdf Configures the conditions under which an HTML to PDF conversion process begins. ```APIDOC ## Class ConversionStartOptions ### Description Allows users to specify the criteria or timing for initiating an HTML to PDF conversion. This can include options related to when the conversion process should start. ### Properties Specific properties for controlling the start of a conversion are not detailed in the provided source. ``` -------------------------------- ### Create PdfLaunchAction with Path Source: https://api.docotic.com/pdfdocument-createlaunchaction Creates a new PdfLaunchAction for a specified file path. Use this when you need to launch an application or open a document. ```csharp public PdfLaunchAction CreateLaunchAction(string path) ``` -------------------------------- ### Get Sorted Widgets from a PDF Page Source: https://api.docotic.com/pdfpage-getsortedwidgets Call this method to get all widgets on a PDF page, sorted by their location. No specific setup or imports are required beyond having a PdfPage object. ```csharp public PdfCollection GetSortedWidgets() ``` -------------------------------- ### LayoutContainer.ShowOnce() Method Signature Source: https://api.docotic.com/layout/layoutcontainer-showonce This is the signature for the ShowOnce() method. It returns the LayoutContainer itself, allowing for method chaining. ```csharp public LayoutContainer ShowOnce() ``` -------------------------------- ### PdfCloseSubpathSegment.End Property Source: https://api.docotic.com/pdfclosesubpathsegment-end Gets the end point of this PdfCloseSubpathSegment, which is equal to the start point of the subpath. ```APIDOC ## PdfCloseSubpathSegment.End Property ### Description Gets the end point of this PdfCloseSubpathSegment, equal to start point of the subpath. ### Property Value PdfPoint The end point of this PdfCloseSubpathSegment, equal to start point of the subpath. ``` -------------------------------- ### StartNumber Property Source: https://api.docotic.com/pdfpagelabelingrange-startnumber Gets or sets the start number for the first page label in a range. Subsequent pages are numbered sequentially from this value. A value of 0 indicates that the start number is not specified. ```APIDOC ## StartNumber Property ### Description Gets or sets the start number (i.e., the value of the numeric portion for the first page label in the range). Subsequent pages are numbered sequentially from this value. The start number is optional and may be 0, which means that the start number should not be used (or not specified). ### Property Value `int` - The start number. ``` -------------------------------- ### Initialize XmpSchema with Uri Source: https://api.docotic.com/xmpschema-ctor Use this constructor to initialize a new XmpSchema instance with a string prefix and a Uri for the schema name. Ensure the URI conforms to XML namespace rules and ends with '/' or '#'. ```csharp public XmpSchema(string prefix, Uri uri)__ ``` -------------------------------- ### Set Start Mode to After Delay Source: https://api.docotic.com/htmltopdf/conversionstartoptions Switches the conversion start mode to 'AfterDelay' and specifies the delay in milliseconds. Use this to postpone conversion by a fixed duration. ```csharp options.SetStartAfterDelay(5000); ``` -------------------------------- ### XmpProperty(string, XmpValue, string) Source: https://api.docotic.com/xmpproperty-ctor Initializes a new instance of the XmpProperty class with a name, an XMP value, and a description. ```APIDOC ## XmpProperty(string, XmpValue, string) ### Description Initializes a new instance of the XmpProperty class with the specified name, value, and description. ### Method Constructor ### Parameters #### Parameters - **name** (string) - Required - The name of the property. - **value** (XmpValue) - Required - The value of the property. - **description** (string) - Required - The description of the property. ``` -------------------------------- ### PageNumber Property Source: https://api.docotic.com/layout/layoutcontext-pagenumber Gets the current page number in the document. The page number starts at 1. ```APIDOC ## PageNumber Gets the current page number in the document. ### Property Value `int` The current page number starting with `1`. ``` -------------------------------- ### PdfRgbColor Constructors Source: https://api.docotic.com/pdfrgbcolor Illustrates various ways to initialize a new instance of the PdfRgbColor class. ```csharp PdfRgbColor(PdfColorProfile, int) Initializes a new instance of the PdfRgbColor class. ``` ```csharp PdfRgbColor(PdfColorProfile, int, int, int) Initializes a new instance of the PdfRgbColor class. ``` ```csharp PdfRgbColor(int) Initializes a new instance of the PdfRgbColor class. ``` ```csharp PdfRgbColor(int, int, int) Initializes a new instance of the PdfRgbColor class. ``` -------------------------------- ### Initialize PdfDocument with Configuration Options Source: https://api.docotic.com/pdfdocument-ctor Use this constructor to open an existing encrypted PDF document from a file name, providing a decryption handler and custom configuration options. Ensure a valid license key is applied before use. ```csharp public PdfDocument(string fileName, PdfDecryptionHandler handler, PdfConfigurationOptions options)__ ``` -------------------------------- ### Get Offset Property Source: https://api.docotic.com/pdfdashpattern-offset Retrieves the distance from the start of a line to the beginning of the dash pattern. This property is read-only. ```csharp public double Offset { get; } ``` -------------------------------- ### Initialize XmpSchema with String Uri Source: https://api.docotic.com/xmpschema-ctor Use this constructor to initialize a new XmpSchema instance with a string prefix and a string representing the schema name. The URI string must obey XML namespace rules and should end in "/" or "#". ```csharp public XmpSchema(string prefix, string uri)__ ``` -------------------------------- ### Get Current Page Number Source: https://api.docotic.com/layout/layoutcontext-pagenumber Retrieves the current page number of the document. The numbering starts from 1. ```csharp public int PageNumber { get; } ``` -------------------------------- ### LoadOptions() Constructor Source: https://api.docotic.com/htmltopdf/loadoptions-ctor Initializes a new instance of the LoadOptions class with default settings. ```APIDOC ## LoadOptions() ### Description Initializes a new instance of the LoadOptions class. ### Method Constructor ### Parameters None ### Response Example ```csharp // Example of creating a new LoadOptions object var options = new LoadOptions(); ``` ``` -------------------------------- ### Initialize PdfRgbColor with RGB components and Color Profile Source: https://api.docotic.com/pdfrgbcolor-ctor Use this constructor to create a new PdfRgbColor instance with a specified ICC color profile and individual red, green, and blue components. Each component must be between 0 and 255. ```csharp public PdfRgbColor(PdfColorProfile colorProfile, int red, int green, int blue)__ ``` -------------------------------- ### Script Property Source: https://api.docotic.com/htmltopdf/conversionstartoptions-script Gets the script to run before the conversion start. This property is part of the HtmlToPdf conversion options. ```APIDOC ## Script Property ### Description Gets the script to run before the conversion start. This property is part of the HtmlToPdf conversion options. ### Property Signature ```csharp public string? Script { get; } ``` ### Property Value string The script to run before the conversion start. ### Remarks Default value: `null`. Use the SetStartAfterScriptRun(string) method to change this value. ``` -------------------------------- ### PdfLineSegment.Start Source: https://api.docotic.com/pdflinesegment-start Gets the start point of this PdfLineSegment. This property returns a PdfPoint object representing the beginning of the line segment. ```APIDOC ## Start ### Description Gets the start point of this PdfLineSegment. ### Property Value PdfPoint - The start point of this PdfLineSegment. ``` -------------------------------- ### Initialize with Default User Certificate Store Source: https://api.docotic.com/pdfpublickeydecryptionhandler-ctor Instantiate a decryption handler using the default X.509 certificate store for the current user. The handler will search this store for a suitable certificate. ```csharp public PdfPublicKeyDecryptionHandler()__ ``` -------------------------------- ### Create PdfPublicKeyEncryptionHandler with Key Store Path Source: https://api.docotic.com/pdfpublickeyencryptionhandler-ctor Use this constructor to create an encryption handler with owner permissions using a key store file. Requires the path to the PFX/PKCS #12 file and its password. ```csharp public PdfPublicKeyEncryptionHandler(string ownerKeyStorePath, string password) ``` -------------------------------- ### Get Script Property Source: https://api.docotic.com/htmltopdf/conversionstartoptions-script Retrieves the script that will be executed before the HTML to PDF conversion starts. The default value is null. ```csharp public string? Script { get; } ``` -------------------------------- ### Get Certificate Validity Start Time Source: https://api.docotic.com/pdfsignaturecertificate-validfrom Retrieves the local date and time from which a digital certificate is valid. This property is read-only. ```csharp public DateTime ValidFrom { get; } ``` -------------------------------- ### XmpProperty Constructor with Name, Value, and Description Source: https://api.docotic.com/xmpproperty-ctor Initializes a new instance of the XmpProperty class with a specified name, value, and description. Use this constructor when you need to provide additional context or explanation for the XMP property. ```csharp public XmpProperty(string name, XmpValue value, string description) ``` -------------------------------- ### Set Start Mode to After Script Run Source: https://api.docotic.com/htmltopdf/conversionstartoptions Switches the conversion start mode to 'AfterScriptRun' and provides a JavaScript string to execute before conversion begins. Use this for dynamic content loading or manipulation. ```csharp options.SetStartAfterScriptRun("document.getElementById('loading').style.display = 'none';"); ``` -------------------------------- ### XmpArray Types Property Source: https://api.docotic.com/xmpdublincoreschema-types Gets or sets the unordered array of document types (for example, novel, poem, or working paper). This property is represented by an XmpArray. ```APIDOC ## Property Types ### Description Gets or sets the unordered array of document types (for example, novel, poem, or working paper). ### Property `XmpArray? Types { get; set; }` ### Property Value `XmpArray` - The unordered array of document types (for example, novel, poem, or working paper). ### Exceptions #### UnsupportedMetadataException The corresponding XMP property has an unexpected type. ``` -------------------------------- ### Create() Source: https://api.docotic.com/pdfconfigurationoptions-create Creates configuration options initialized with a stream provider of the default type. By default, the library uses instances of PdfMixedStorageStreamProvider for document stream providers. ```APIDOC ## Create() ### Description Creates configuration options initialized with a stream provider of the default type. ### Method Signature ```csharp public static PdfConfigurationOptions Create() ``` ### Returns PdfConfigurationOptions The newly created configuration options initialized with a stream provider of the default type. ### Remarks By default, the library uses instances of PdfMixedStorageStreamProvider for document stream providers. To use a stream provider of a different type, please refer to CreateWithStreamProvider(IPdfStreamProvider). Read the Font loading in cloud environments for an example of using this method. ``` -------------------------------- ### Create a new PdfDocumentBuilder instance Source: https://api.docotic.com/layout/pdfdocumentbuilder-create Use this static method to get a new instance of PdfDocumentBuilder. Refer to the Building documents article for usage examples. ```csharp public static PdfDocumentBuilder Create() ``` -------------------------------- ### Open PdfDocument from File with Configuration Source: https://api.docotic.com/pdfdocument-ctor Opens an existing PDF document from a file path using specified configuration options. Consult the 'Font loading in cloud environments' section for examples. License keys are required. ```csharp public PdfDocument(string fileName, PdfConfigurationOptions options) ``` -------------------------------- ### Delay Property Source: https://api.docotic.com/htmltopdf/conversionstartoptions-delay Gets the delay in milliseconds before the HTML to PDF conversion starts. The default value is 0. This property can be modified using the SetStartAfterDelay(int) method. ```APIDOC ## Delay Property ### Description Gets the delay before the conversion start, in milliseconds. ### Property Value int - The delay before the conversion start, in milliseconds. ### Remarks Default value: 0. Use the SetStartAfterDelay(int) method to change this value. ``` -------------------------------- ### Create PdfSigningOptions with Key Store File Source: https://api.docotic.com/pdfsigningoptions Creates a new PdfSigningOptions instance using a specified key store file and password. ```csharp PdfSigningOptions(string, string) ``` -------------------------------- ### HtmlToPdf Delay Property Source: https://api.docotic.com/htmltopdf/conversionstartoptions-delay This C# code snippet shows the definition of the Delay property, which gets the delay in milliseconds before the conversion starts. The default value is 0. ```csharp public int Delay { get; } ``` -------------------------------- ### PdfPermissionFlags Property Source: https://api.docotic.com/pdfpermissions-flags Gets or sets the permissions as bit flags for a PDF document. Refer to the 'Encrypt PDF documents in C# and VB.NET' article for usage examples. ```csharp public PdfPermissionFlags Flags { get; set; } ``` -------------------------------- ### Create Blank PdfDocument with Configuration Source: https://api.docotic.com/pdfdocument-ctor Creates a new blank PDF document with specified configuration options. Refer to the 'Font loading in cloud environments' section for usage examples. License keys must be applied beforehand. ```csharp public PdfDocument(PdfConfigurationOptions options) ``` -------------------------------- ### Begin Marked Content with String Tag Source: https://api.docotic.com/pdfcanvas-beginmarkedcontent Use this overload to start a marked content sequence with a custom string tag. The optional properties can provide additional creator-specific information. ```csharp public void BeginMarkedContent(string tag, IPdfPropertyList? properties = null)__ ``` -------------------------------- ### Get or Set OnLostFocus Action Source: https://api.docotic.com/pdfcontrol-onlostfocus This property retrieves or sets the PdfAction to be executed when the control loses input focus. Refer to the Remarks section for usage examples. ```csharp public PdfAction? OnLostFocus { get; set; } ``` -------------------------------- ### Get or Set PdfCanvas.TextPosition Source: https://api.docotic.com/pdfcanvas-textposition Retrieves or specifies the current text position for drawing operations. Consecutive text operations will use this position if no explicit start position is provided. ```csharp public PdfPoint TextPosition { get; set; } ``` -------------------------------- ### Create PdfSigningOptions with Key Store Stream Source: https://api.docotic.com/pdfsigningoptions-ctor Initializes PdfSigningOptions using a stream and password for PFX or PKCS #12 key store contents. ```csharp public PdfSigningOptions(Stream stream, string password)__ ``` -------------------------------- ### Get PdfFont Face Name Source: https://api.docotic.com/pdffont-name Retrieves the face name of a PdfFont object. This property is useful for identifying the specific font being used. Refer to the 'Unembed fonts' section for usage examples. ```csharp public string Name { get; } ``` -------------------------------- ### Initialize ConformanceException with no arguments Source: https://api.docotic.com/conformance/conformanceexception-ctor Use this constructor to create a new instance of the ConformanceException class without any specific message or inner exception. ```csharp public ConformanceException()__ ``` -------------------------------- ### Accessing CosDictionary Item by Key Source: https://api.docotic.com/cosdictionary-item Use this indexer to get the value associated with a specific key from the dictionary. The key must not be null and should not start with a leading slash. Empty strings are valid keys. ```csharp public CosObject this[string key] { get; } ``` -------------------------------- ### ShowOnce() Source: https://api.docotic.com/layout/layoutcontainer-showonce Marks the container to show the content on the current page and skip on the next pages. This method is useful for ensuring that certain content, like headers or footers, appears only once. ```APIDOC ## ShowOnce() ### Description Marks the container to show the content on the current page and skip on the next pages. ### Method ```csharp public LayoutContainer ShowOnce() ``` ### Returns LayoutContainer - The nested container with the applied rule. ### Remarks Read the ShowOnce section of the Size, position, and rendering of containers article for examples of using this method. ``` -------------------------------- ### Initialize PdfRgbColor with RGB components Source: https://api.docotic.com/pdfrgbcolor-ctor Use this constructor to create a new PdfRgbColor instance by specifying the red, green, and blue color components. Each component must be between 0 and 255. ```csharp public PdfRgbColor(int red, int green, int blue)__ ``` -------------------------------- ### Get and Set Image Compression Options Source: https://api.docotic.com/pdfdrawoptions-compression This property allows you to specify the image compression options to be used when saving images generated from a PDF. Refer to the 'Convert PDF to image in C# and VB.NET' article for usage examples. ```csharp public ImageCompressionOptions Compression { get; set; } ``` -------------------------------- ### Get Current Page Number Source: https://api.docotic.com/layout/textcontainer-currentpagenumber Adds the current page number to the current paragraph. If sectionName is null, it returns the document's current page number. Otherwise, it returns the page number relative to the start of the specified section. ```csharp public TextPageNumber CurrentPageNumber(string? sectionName = null) ``` -------------------------------- ### Initialize XmpStructure with Prefix and URI Source: https://api.docotic.com/xmpstructure-ctor Use this constructor to create an XmpStructure object by providing a namespace prefix and its corresponding URI. ```csharp public XmpStructure(string prefix, string uri) ``` -------------------------------- ### Get Page Source: https://api.docotic.com/pdfdocument Gets the page with the specified index. ```APIDOC ## GetPage(int) ### Description Gets the page with the specified index. ### Method Not specified (assumed to be a method call within an SDK) ### Parameters * **pageIndex** (int) - Required - The index of the page to retrieve. ``` -------------------------------- ### Initialize UnsupportedFontException Source: https://api.docotic.com/unsupportedfontexception-ctor Use this constructor to create a new instance of UnsupportedFontException without any specific message. ```csharp public UnsupportedFontException()__ ``` -------------------------------- ### Get or Set Width Source: https://api.docotic.com/pdfrectangle Gets or sets the width of the rectangle. ```csharp Width ``` -------------------------------- ### Initialize LoadOptions Source: https://api.docotic.com/htmltopdf/loadoptions-ctor Initializes a new instance of the LoadOptions class using the default constructor. ```csharp public LoadOptions()__ ``` -------------------------------- ### Get or Set Size Source: https://api.docotic.com/pdfrectangle Gets or sets the size of the rectangle. ```csharp Size ``` -------------------------------- ### Get or Set Height Source: https://api.docotic.com/pdfrectangle Gets or sets the height of the rectangle. ```csharp Height ``` -------------------------------- ### Initialize PdfDocument from Stream with Configuration Options Source: https://api.docotic.com/pdfdocument-ctor Use this constructor to open an existing encrypted PDF document from a stream, providing a decryption handler and custom configuration options. The stream must support reading and seeking. Ensure a valid license key is applied before use. ```csharp public PdfDocument(Stream stream, PdfDecryptionHandler handler, PdfConfigurationOptions options)__ ``` -------------------------------- ### Get or Set Y-coordinate Source: https://api.docotic.com/pdfpoint Gets or sets the y-coordinate of this PdfPoint. ```csharp Y ``` -------------------------------- ### CreatePng() - Create PNG Image Compression Options Source: https://api.docotic.com/imagecompressionoptions-createpng Use this method to create default PngImageCompressionOptions. The returned options will configure the image to use RGB color space, and an alpha channel may be included based on the BackgroundColor property. ```csharp public static PngImageCompressionOptions CreatePng() ``` -------------------------------- ### Get or Set X-coordinate Source: https://api.docotic.com/pdfpoint Gets or sets the x-coordinate of this PdfPoint. ```csharp X ``` -------------------------------- ### Get(string prefix) Source: https://api.docotic.com/xmpschemalist-get Retrieves an XMP schema from the list based on its namespace prefix. Returns null if no schema matches the provided prefix. ```APIDOC ## Get(string prefix) ### Description Gets the schema with the specified namespace prefix. ### Method `public XmpSchema? Get(string prefix)` ### Parameters #### Path Parameters - **prefix** (string) - Required - The namespace prefix of the property to get. #### Returns - **XmpSchema** - The schema with the specified namespace prefix or `null` if there is no schema with the specified namespace prefix in this XmpSchemaList. ``` -------------------------------- ### Initialize DefaultFallbackFontProvider Source: https://api.docotic.com/defaultfallbackfontprovider-ctor Initializes a new instance of the DefaultFallbackFontProvider class. This is the default constructor. ```csharp public DefaultFallbackFontProvider() ``` -------------------------------- ### Get Top Coordinate Source: https://api.docotic.com/pdfrectangle Gets the y-coordinate of the top edge of the rectangle. ```csharp Top ``` -------------------------------- ### Initialize UnsupportedMetadataException Source: https://api.docotic.com/unsupportedmetadataexception-ctor Initializes a new instance of the UnsupportedMetadataException class with no arguments. ```csharp public UnsupportedMetadataException()__ ``` -------------------------------- ### Get Right Coordinate Source: https://api.docotic.com/pdfrectangle Gets the x-coordinate of the right edge of the rectangle. ```csharp Right ``` -------------------------------- ### PdfRgbColorSpace() Source: https://api.docotic.com/pdfrgbcolorspace-ctor Initializes a new instance of the PdfRgbColorSpace class. This is a parameterless constructor. ```APIDOC ## PdfRgbColorSpace() ### Description Initializes a new instance of the PdfRgbColorSpace class. ### Method Constructor ### Parameters None ### Response Example ```json { "message": "Instance of PdfRgbColorSpace created successfully." } ``` ``` -------------------------------- ### Get Left Coordinate Source: https://api.docotic.com/pdfrectangle Gets the x-coordinate of the left edge of the rectangle. ```csharp Left ``` -------------------------------- ### Get Bottom Coordinate Source: https://api.docotic.com/pdfrectangle Gets the y-coordinate of the bottom edge of the rectangle. ```csharp Bottom ``` -------------------------------- ### Initialize PdfRgbColorSpace Source: https://api.docotic.com/pdfrgbcolorspace-ctor Initializes a new instance of the PdfRgbColorSpace class. This is the default constructor. ```csharp public PdfRgbColorSpace() ``` -------------------------------- ### AddActionAreas Source: https://api.docotic.com/pdfstringdrawingoptions-addactionareas Gets or sets a value indicating whether to add action areas for each URI in the drawn text string. If true, the library will add a hyperlink-like action area over every URI found in the drawn text. If false, the library won't add anything. Default value is false. The library recognizes URIs that start with http://, https://, mailto:, and ftp://. ```APIDOC ## AddActionAreas ### Description Gets or sets a value indicating whether to add action areas for each URI in the drawn text string. If `true`, the library will add a hyperlink-like action area (see PdfActionArea) over every URI found in the drawn text. If `false`, the library won't add anything. ### Property Value `bool` ### Remarks Default value: `false`. The library recognizes URIs that start with `http://`, `https://`, `mailto:`, and `ftp://`. ``` -------------------------------- ### Get or Set Location Source: https://api.docotic.com/pdfrectangle Gets or sets the coordinates of the upper-left corner of the rectangle. ```csharp Location ``` -------------------------------- ### PdfSigningOptions(string, string) Source: https://api.docotic.com/pdfsigningoptions-ctor Creates a new signing options instance using a specified key store file path and its password. ```APIDOC ## PdfSigningOptions(string path, string password) ### Description Creates a new signing options instance using specified key store file. ### Parameters #### Path Parameters - **path** (string) - Required - Path to PFX / PKCS #12 file used for signing. - **password** (string) - Required - The password to read the key store file. ### Remarks PFX files are expected to have .pfx extension. PKCS #12 files are expected to have .p12 extension. The Sign PDF documents in C# and VB.NET article describes how to apply digital signatures to PDF documents. ``` -------------------------------- ### XmpSchema(string, Uri) Source: https://api.docotic.com/xmpschema-ctor Initializes a new instance of the XmpSchema class with a specified prefix and URI. ```APIDOC ## XmpSchema(string prefix, Uri uri) ### Description Initializes a new instance of the XmpSchema class. ### Parameters #### Parameters - **prefix** (string) - The schema namespace prefix. - **uri** (Uri) - The name of the schema. #### Remarks Metadata should not contain duplicate schemas, so the ArgumentException will be thrown if metadata already contains schema with specified namespace prefix. Creation of schemas with well-known prefixes is forbidden. Please use corresponding properties of XmpMetadata to access properties of a well-known schema. Each schema consists of a schema name and namespace prefix. The name is a URI that serves to uniquely identify the schema. It is simply a unique string. A schema name looks like an URI (e.g. 'http://ns.adobe.com/xap/1.0/') but there might or might not be an actual Web page at the URI. The URI must obey XML namespace rules, and it should end in "/" or "#". A schema namespace prefix is a short abbreviation for the full schema name. The prefix is used for properties in the schema. ``` -------------------------------- ### Get PDF/X Conformance Source: https://api.docotic.com/pdfdocument Gets PDF/X standard conformance level for this PdfDocument. ```APIDOC ## GetPdfxConformance() ### Description Gets PDF/X standard conformance level for this PdfDocument. ### Method Not specified (assumed to be a method call within an SDK) ``` -------------------------------- ### Get PDF/A Conformance Source: https://api.docotic.com/pdfdocument Gets PDF/A standard conformance level for this PdfDocument. ```APIDOC ## GetPdfaConformance() ### Description Gets PDF/A standard conformance level for this PdfDocument. ### Method Not specified (assumed to be a method call within an SDK) ``` -------------------------------- ### ConversionStartOptions Properties Source: https://api.docotic.com/htmltopdf/conversionstartoptions Provides information about the properties of the ConversionStartOptions class. ```APIDOC ## Delay ### Description Gets the delay before the conversion start, in milliseconds. ### Type int ``` ```APIDOC ## Mode ### Description Gets the start mode. ### Type ConversionStartMode ``` ```APIDOC ## Script ### Description Gets the script to run before the conversion start. ### Type string ``` -------------------------------- ### Initialize PdfMemoryStreamProvider Source: https://api.docotic.com/pdfmemorystreamprovider-ctor Initializes a new instance of the PdfMemoryStreamProvider class. This is the default constructor. ```csharp public PdfMemoryStreamProvider() ``` -------------------------------- ### Get and Set PdfLineJoin Property Source: https://api.docotic.com/pdfpen-linejoin This property gets or sets the PdfLineJoin value. The default value is Miter. ```csharp public PdfLineJoin LineJoin { get; set; } ``` -------------------------------- ### Get and Set DeactivationMode Source: https://api.docotic.com/pdf3dactivationsettings-deactivationmode This property gets or sets the deactivation mode for an annotation. The default value is OnPageInvisible. ```csharp public PdfRichMediaDeactivationMode DeactivationMode { get; set; } ``` -------------------------------- ### Initialize PdfRgbColor with ARGB value and Color Profile Source: https://api.docotic.com/pdfrgbcolor-ctor Use this constructor to create a new PdfRgbColor instance with a specified ICC color profile and a 32-bit ARGB integer value. ```csharp public PdfRgbColor(PdfColorProfile colorProfile, int argb)__ ``` -------------------------------- ### Get and Set ActivationMode Source: https://api.docotic.com/pdf3dactivationsettings-activationmode This property gets or sets the activation mode for a Pdf3dAnnotation. The default value is ExplicitActivation. ```csharp public PdfRichMediaActivationMode ActivationMode { get; set; } ``` -------------------------------- ### Example PDF Dictionary Object Source: https://api.docotic.com/cosdictionary Illustrates the structure of a dictionary object within a PDF file, showing key-value pairs like Type, Parent, MediaBox, and Contents. ```csharp << /Type /Page /Parent 3 0 R /MediaBox [0 0 612 792] /Contents 5 0 R >> ``` -------------------------------- ### Get(string name) Source: https://api.docotic.com/pdfdocumentviewcollection-get Gets the PdfDocumentView by its specified name. Returns the view if found, otherwise returns null. ```APIDOC ## Get(string name) ### Description Gets the view by name. ### Method GET ### Endpoint /views/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The view name. ### Response #### Success Response (200) - **PdfDocumentView** (object) - The view for the given name or `null` if the view is not found. #### Response Example { "example": "{\"name\": \"MyView\", \"someOtherProperty\": \"value\"}" } ``` -------------------------------- ### Add(string name, string value, string description) Source: https://api.docotic.com/xmppropertylist-add Creates a new XMP property with the given name, string value, and description, and adds it to the XmpPropertyList. The property value can be null. An ArgumentException is thrown if a property with the same name already exists. ```APIDOC ## Add(string name, string value, string description) ### Description Creates a new XMP property and adds it to the end of this XmpPropertyList. ### Method BitMiracle.Docotic.Pdf.XmpProperty Add(string name, string value, string description) ### Parameters #### Parameters - **name** (string) - Required - The name of the property. - **value** (string) - Required - The value of the property. - **description** (string) - Required - The description of the property. ### Returns - **XmpProperty** - The newly created XMP property. ### Remarks The value of the property specified by `value` can be `null`. Collection should not contain duplicate properties, so the ArgumentException will be thrown if this XmpPropertyList already contains property with specified name. ``` -------------------------------- ### Get and Set PdfPageLayout Source: https://api.docotic.com/pdfdocument-pagelayout This property gets or sets the page layout for the PDF document. The default value is PdfPageLayout.Default. ```csharp public PdfPageLayout PageLayout { get; set; } ``` -------------------------------- ### Create PdfPublicKeyEncryptionHandler with Key Store Stream and Permissions Source: https://api.docotic.com/pdfpublickeyencryptionhandler-ctor Use this constructor to create an encryption handler with specified permissions using a stream containing key store contents. Requires the stream, its password, and the desired permissions. ```csharp public PdfPublicKeyEncryptionHandler(Stream keyStoreStream, string password, PdfPermissions permissions) ``` -------------------------------- ### Get and Set ControlMergingMode Source: https://api.docotic.com/pdfmergingoptions-controlmergingmode This property gets or sets the value indicating how to merge PDF controls. The default value is CopyWithRename. ```csharp public PdfControlMergingMode ControlMergingMode { get; set; } ``` -------------------------------- ### Initialize PdfSignatureTimestampOptions Source: https://api.docotic.com/pdfsignaturetimestampoptions-ctor Creates a new instance of the PdfSignatureTimestampOptions class using its default constructor. ```csharp public PdfSignatureTimestampOptions() ``` -------------------------------- ### CreatePng() Method Source: https://api.docotic.com/paintedimagecompressionoptions-createpng Creates default options for PNG image compression. This method is static and belongs to the PaintedImageCompressionOptions class. ```csharp public static PaintedImageCompressionOptions CreatePng()__ ``` -------------------------------- ### Left Property Source: https://api.docotic.com/pdfdocumentview-left Gets the x-coordinate of the upper-left corner of the page to be positioned at the upper-left corner of the window when this view gets displayed. ```APIDOC ## Left Property ### Description Gets the x-coordinate of the upper-left corner of the page to be positioned at the upper-left corner of the window when this view gets displayed. ### Property Value double The x-coordinate of the upper-left corner of the page to be positioned at the upper-left corner of the window. ``` -------------------------------- ### Get SystemFontLoader Instance Source: https://api.docotic.com/systemfontloader-instance Access the static Instance property to retrieve the singleton SystemFontLoader object. This is the only way to get an instance of this class. ```csharp public static SystemFontLoader Instance { get; } ``` -------------------------------- ### XmpProperty Constructors Source: https://api.docotic.com/xmpproperty Initializes a new instance of the XmpProperty class with a name and value, or with a name, value, and namespace prefix. ```APIDOC ## Constructors ### XmpProperty(string name, XmpValue value) Initializes a new instance of the `XmpProperty` class. ### XmpProperty(string name, XmpValue value, string prefix) Initializes a new instance of the `XmpProperty` class. ``` -------------------------------- ### AuthenticationOptions() Constructor Source: https://api.docotic.com/htmltopdf/authenticationoptions-ctor Initializes a new instance of the AuthenticationOptions class. This is the default constructor. ```csharp public AuthenticationOptions() ``` -------------------------------- ### Get and Set PdfDigestAlgorithm Source: https://api.docotic.com/pdfsigningoptions-digestalgorithm This property gets or sets the digest algorithm to use when signing a PDF document. The default value is Sha1. ```csharp public PdfDigestAlgorithm DigestAlgorithm { get; set; } ``` -------------------------------- ### Get and Set VerticalResolution Source: https://api.docotic.com/pdfdrawoptions-verticalresolution This snippet shows how to get or set the VerticalResolution property. The default value is 72, and the value should be between 1 and 2000. ```csharp public double VerticalResolution { get; set; } ``` -------------------------------- ### Create PDF from File Asynchronously Source: https://api.docotic.com/htmltopdf/htmlconverter-createpdfasync Use this overload to create a PDF document from an HTML file. The conversion happens asynchronously. ```csharp public Task CreatePdfAsync(string fileName, HtmlConversionOptions? options = null)__ ``` -------------------------------- ### Get and Set FieldOfView Property Source: https://api.docotic.com/pdf3dprojection-fieldofview This snippet shows how to get or set the FieldOfView property of a virtual camera. It is only relevant for perspective projections. ```csharp public double? FieldOfView { get; set; } ``` -------------------------------- ### Initialize PdfPaintedImageSavingOptions Source: https://api.docotic.com/pdfpaintedimagesavingoptions-ctor Creates a new instance of the PdfPaintedImageSavingOptions class using its default constructor. ```csharp public PdfPaintedImageSavingOptions() ``` -------------------------------- ### Initialize PdfCmykColorSpace Source: https://api.docotic.com/pdfcmykcolorspace-ctor Initializes a new instance of the PdfCmykColorSpace class. This is the default constructor. ```csharp public PdfCmykColorSpace()__ ``` -------------------------------- ### Get and Set PresentationStyle Source: https://api.docotic.com/pdf3dactivationsettings-presentationstyle This C# code snippet shows how to get or set the PdfRichMediaPresentationStyle for 3D content. The default value is 'Embedded'. ```csharp public PdfRichMediaPresentationStyle PresentationStyle { get; set; } ``` -------------------------------- ### Remove Pages from Start Index to End Source: https://api.docotic.com/pdfdocument-removepages Use this overload to remove all pages starting from a specified zero-based index to the end of the document. ```csharp public void RemovePages(int startIndex)__ ``` -------------------------------- ### Add Owner with Key Store File Source: https://api.docotic.com/pdfpublickeyencryptionhandler-addowner Adds a new recipient with owner permissions using a key store file (PFX/PKCS #12). Provide the path to the file and its password. The certificate within the keystore is assumed to be an owner certificate. ```csharp public void AddOwner(string ownerKeyStorePath, string password)__ ``` -------------------------------- ### XmpStructure Constructors Source: https://api.docotic.com/xmpstructure Provides information on how to initialize a new instance of the XmpStructure class. ```APIDOC ## XmpStructure(string, string) ### Description Initializes a new instance of the XmpStructure class. ### Parameters * **namespace** (string) - The namespace of the XMP structure. * **prefix** (string) - The namespace prefix for properties in this XMP structure. ``` -------------------------------- ### Get or Set VersionId Property Source: https://api.docotic.com/xmpmediamanagementschema-versionid This snippet shows how to get or set the VersionId property. It is of type XmpString and is used for the document version identifier. ```csharp public XmpString? VersionId { get; set; } ```