GridPdfSettings
Container of misc. grouping settings of RadGrid control
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridPdfSettings : ObjectWithState
Inheritance: objectObjectWithStateGridPdfSettings
Inherited Members
Constructors
GridPdfSettings constructor (for internal use only)
public GridPdfSettings(StateBag OwnerStateBag)
StateBag of the owner
Properties
Allow the document to be modified
public bool AllowModify { get; set; }
Allow the content of the PDF file to be printed
public bool AllowPrinting { get; set; }
Determines the color of the borders
public Color BorderColor { get; set; }
Determines the thickness of the border
public GridPdfSettings.GridPdfBorderStyle BorderStyle { get; set; }
Determines the border type for the exported RadGrid
public GridPdfSettings.GridPdfBorderType BorderType { get; set; }
Determines the default content filter used by the PDF engine
public GridPdfFilter ContentFilter { get; set; }
Determines the default font
public string DefaultFontFamily { get; set; }
Determines whether the content encryption will be disabled
public bool DisableContentEncryption { get; set; }
FontType
FontType
This property describes the different types of font embedding: Link, Embed and Subset.
public FontType FontType { get; set; }
Possible values:
Link
The font program is referenced by name in the rendered PDF. Anyone who views a rendered PDF with a linked font program must have that font installed on their computer otherwise it will not display correctly. Embed
The entire font program is embedded in the rendered PDF. Embedding the entire font program guarantees the PDF will display as intended by the author on all computers, however this method does possess several disadvantages:
Font programs can be extremely large and will significantly increase the size of the rendered PDF. For example, the MS Gothic TrueType collection is 8MB! Certain font programs cannot be embedded due to license restrictions. If you attempt to embed a font program that disallows embedding, RadGrid will substitute the font with a base 14 font and generate a warning message. Subset (default value)
Subsetting a font will generate a new font that is embedded in the rendered PDF that contains only the chars referenced by RadGrid. For example, if a particular RadGrid utilised the Verdana font referencing only the character 'A', a subsetted font would be generated at run-time containing only the information necessary to render the character 'A'.
Subsetting provides the benefits of embedding and significantly reduces the size of the font program. However, small processing overhead is incurred to generated the subsetted font.
Determines what will happen when a given text is larger than the cell width (and there are no whitespaces inside). If set to true, the overflowing text will be carried over to the next line; otherwise (false) the text will break the cell boundaries
public bool ForceTextWrap { get; set; }
Document keywords (comma-separated)
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(GridStringArrayConverter))]
public virtual string[] Keywords { get; set; }
The bottom margin of the page
public Unit PageBottomMargin { get; set; }
This element holds the contents of the footer zone of the page
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridPdfPageHeaderFooter PageFooter { get; }
The margin of the page footer
public Unit PageFooterMargin { get; set; }
PageHeader element holds the contents of the header zone
[PersistenceMode(PersistenceMode.InnerProperty)]
public GridPdfPageHeaderFooter PageHeader { get; }
The margin of the page header
public Unit PageHeaderMargin { get; set; }
Gets or sets the page height that RadGrid will use when exporting to PDF.
public Unit PageHeight { get; set; }
This setting will override any predefined value that comes from the PaperSize property.
The left margin of the page
public Unit PageLeftMargin { get; set; }
The right margin of the page
public Unit PageRightMargin { get; set; }
The top margin of the page
public Unit PageTopMargin { get; set; }
Gets or sets the page width that RadGrid will use when exporting to PDF.
public Unit PageWidth { get; set; }
This setting will override any predefined value that comes from the PaperSize property.
Gets or sets the physical paper size that RadGrid will use when exporting to PDF.
public GridPaperSize PaperSize { get; set; }
It will be overriden by setting PageWidth and PageHeight explicitly.
Determines whether the exported document will be password protected.
public string UserPassword { get; set; }