DocumentWriterSvgPage Class

Summary

Data for one SVG page to be added to a document file.

Syntax

Objective-C

C++

Java

public class DocumentWriterSvgPage : DocumentWriterPage

Public Class DocumentWriterSvgPage  
   Inherits DocumentWriterPage

@interface LTDocumentWriterSvgPage : LTDocumentPage <NSCopying>

public class DocumentWriterSvgPage extends DocumentWriterPage

public ref class DocumentWriterSvgPage : public DocumentWriterPage

Remarks

The DocumentWriterSvgPage class derives from DocumentWriterPage and contains the data for one SVG page to be added to a document file. It is used as a parameter to the DocumentWriter.AddPage or DocumentWriter.InsertPage methods used to add the page.

The DocumentWriterSvgPage.SvgDocument property must contain a valid SVG (ISvgDocument) object that contains the visual representation of the page. This SVG object can obtained through multiple sources as explained in LEADTOOLS Document Writers.

DocumentWriterSvgPage.SvgDocument is used as is when DocumentWriter.AddPage or DocumentWriter.InsertPage is called and the framework does not delete it. You must dispose the object when it is no longer used.

The DocumentWriterSvgPage.Image property is optional and is used only when the document being created is PDF with the Image/Text overlay option. To create a PDF document with image/text overlay, perform the following steps:

Set the value of the PdfDocumentOptions.ImageOverText to true. You can use the DocumentWriter.GetOptions and DocumentWriter.SetOptions methods to the get the options used when saving a PDF document.
Call DocumentWriter.BeginDocument with DocumentFormat.Pdf as the format to use.
Add the document pages. The DocumentWriterSvgPage.SvgDocument property must point to the SVG object containing the representation of the page and the DocumentWriterSvgPage.Image must contain a RasterImage object for the image to be used as the overlay for the page.
Repeat for each page in the document.
Call DocumentWriter.EndDocument to finish creating the document file on disk.

SVG documents may or may not have a size. If a document has a size, it is stored in the width and height attributes of the root svg element and can be in any coordinate system. An SVG renderer will typically use this value to determine the final bounding rectangle of the document. SVG documents contain a hierarchy of elements. The final transformation (such as position and size) and style (such as color and fill) may depend on the transformation and style of the parent(s) inside the hierarchy. Calculations have to be done to keep track of this information when converting the SVG file. This procedure is defined by LEADTOOLS as flattening the document.

The DocumentWriterSvgPage.Width and DocumentWriterSvgPage.Height properties can be used to set a custom page size in inches. When the values are the default of 0, the framework will obtain the page width and height automatically from the ISvgDocument object set in SvgDocument when AddPage or InsertPage is called. If it is desired to create pages at a custom size, then simply set the values (in inches) in DocumentWriterSvgPage.Width and DocumentWriterSvgPage.Height before calling AddPage or InsertPage.

The LEADTOOLS Document Writer supports creating documents with zero or more empty pages inside them. Use AddPage or InsertPage with an DocumentWriterEmptyPage with the dimension of the empty page set before hand in the DocumentOptions.EmptyPageWidth and DocumentOptions.EmptyPageHeight and its resolution set to DocumentOptions.EmptyPageResolution. As many empty pages as desired can be added in any index desired. To use empty pages, make sure the DocumentOptions.PageRestriction property is set to DocumentPageRestriction.Relaxed.

For more information, refer to PdfDocumentOptions.

Example

For an example, refer to DocumentWriter.

Requirements

Target Platforms