[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.Text.Font

Class Font

Namespace
GrapeCity.Documents.Pdf.Text
Assembly
GcDocs.Pdf.dll

The base abstract class representing a font in a PDF document.

public abstract class Font : PdfDictWrapper, IPdfDict
Inheritance
object
Font
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Properties

BaseFont

Gets or sets the PostScript name of the font.

public string BaseFont { get; set; }

Property Value

string

IsEmbedded

Gets a value indicating whether the font is embedded.

public abstract bool IsEmbedded { get; }

Property Value

bool

propBaseFont

Gets the value of BaseFont entry.

public PdfName propBaseFont { get; }

Property Value

PdfName

Methods

CreateNativeFont()

Gets a Font object created from the embedded font data.

Note that this method will return null if the font is not embedded or does not support this operation (e.g. Type3 fonts). 

public abstract Font CreateNativeFont()

Returns

Font

The Font object.

GetEmbeddedData()

Returns the stream containing the embedded font data, returns null if the font is not embedded, the stream should be disposed after usage.

public Stream GetEmbeddedData()

Returns

System.IO.Stream

The stream with font data or null if the font is not embedded.

GetFontAttributes(out string, out FontWeight?, out FontStretch?, out bool?)

Extracts the attributes of the current font. If a specific attribute cannot be determined, the corresponding output value is set to null.

public void GetFontAttributes(out string fontFamily, out FontWeight? fontWeight, out FontStretch? fontStretch, out bool? fontItalic)

Parameters

fontFamily string
fontWeight FontWeight?
fontStretch FontStretch?
fontItalic bool?

GetFontDescriptor()

Gets an FontDescriptor object that describes the font.

public abstract FontDescriptor GetFontDescriptor()

Returns

FontDescriptor

The FontDescriptor object.

RemoveEmbeddedData(GcPdfDocument)

Removes the embedded font data.

Please note that a PDF may display incorrectly after removing an embedded font's data. Use with caution.

public abstract void RemoveEmbeddedData(GcPdfDocument doc)

Parameters

doc GcPdfDocument

The document that owns the font.

TryGetPdfCode(string, out uint, out int)

Tries to convert a Unicode value to the character's PDF code.

Note that this method can fail if the font does not contain the necessary info for the conversion or does not contain the specified Unicode value.

Note also that this method can be slow as it uses large font tables like /Encoding, /ToUnicode etc., so it is recommended that the returned results are cached by the caller. 

public abstract bool TryGetPdfCode(string unicode, out uint pdfCode, out int pdfCodeLength)

Parameters

unicode string

The character Unicode.

pdfCode uint

OUT: The character PDF code.

pdfCodeLength int

OUT: The length of pdfCode in bytes.

Returns

bool

true if the conversion was successful, false otherwise.

TryGetUnicode(uint, out string)

Converts a character's PDF code to its Unicode value.

Note that this method can fail if the font does not contain the necessary info for the conversion.

Note also that this method can be slow as it uses large font tables like /Encoding, /ToUnicode etc., so the returned results better be cached by the caller. 

public abstract bool TryGetUnicode(uint pdfCode, out string unicode)

Parameters

pdfCode uint

The character PDF code.

unicode string

OUT: The character Unicode.

Returns

bool

True if the conversion was successful, false otherwise.