-
Classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionHide
- ActionImportData
- ActionJavaScript
- ActionJavaScriptMap
- ActionLaunch
- ActionLaunchWinAttrs
- ActionNamed
- ActionResetForm
- ActionSound
- ActionSubmitForm
- ActionUnknown
- ActionUri
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- AppearanceStream
- AppearanceStreams
- AssociatedFiles
- Attr
- AttrClsRevision
- AttrClsRevisionCollection
- AttrCollection
- AttrRevision
- AttrRevisionCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ClassMap
- ComboBoxField
- CombTextField
- ContentItemLink
- ContentItemLinkCollection
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBh
- DestinationFitBv
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXyz
- DocAction
- DocumentDestinations
- DocumentInfo
- DocumentSecurityStore
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileInfo
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FormXObject
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- IccProfile
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkInfo
- MarkupAnnotation
- McidContentItemLink
- McrContentItemLink
- Metadata
- Model3DAnnotation
- Model3DStream
- Model3DView
- Model3DViewCollection
- Namespace
- NamespaceCollection
- ObjectBase
- ObjectManager
- ObjrContentItemLink
- OutlineNode
- OutlineNodeCollection
- OutputIntent
- OutputIntentCollection
- PageLabelingRange
- PageLabelingRangeMap
- PdfCidFont
- PdfCidFontType0
- PdfCidFontType2
- PdfCidFontUnknown
- PdfCMapTable
- PdfContext
- PdfDocument
- PdfFont
- PdfFontDescriptor
- PdfFontSimple
- PdfFontTrueType
- PdfFontType0
- PdfFontType1
- PdfFontType3
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- PdfSignature
- Pen
- Pkcs7Signer
- Pkcs7SignerBase
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RContentItemLink
- RedactAnnotation
- RichMediaAnnotation
- RoleMap
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- StructElement
- StructElementCollection
- StructTreeItem
- StructTreeItemCollection
- StructTreeRoot
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- TimeStamper
- TimeStampProvider
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- Enumerations
- Functions
- Interfaces
- README
- Index
- TypeAliases
- Variables
Format
Class: Format
Represents a text format.
Extends
Constructors
Constructor
new Format(formatProperties): Format;
Creates a new Format object with specified properties.
Parameters
formatProperties
Text formatting attributes such as font, colors, decorations and so on.
Returns
Format
Overrides
ObjectBase.constructor
Constructor
new Format(baseFormat, formatProperties): Format;
Creates a new Format based on properties of an existing Format.
Parameters
baseFormat
Format
The Format used as the base for the new Format.
formatProperties
The settings overriding properties of the base Format.
Returns
Format
Overrides
ObjectBase.constructor
Constructor
new Format(om, formatProperties): Format;
Creates a new Format object with specified properties.
Parameters
om
An object manager that controls the lifetime of the Format object.
formatProperties
Text formatting attributes such as font, colors, decorations and so on.
Returns
Format
Overrides
ObjectBase.constructor
Accessors
allowFontSbits
Get Signature
get allowFontSbits(): boolean;
Gets a value indicating if the embedded bitmaps from the EBDT font table can be used.
Returns
boolean
backColor
Get Signature
get backColor(): Color;
Gets the text background color.
Returns
bold
Get Signature
get bold(): boolean;
Gets a value indicating whether the font should be bolded.
Returns
boolean
charWidthFactor
Get Signature
get charWidthFactor(): number;
Gets the character width scale factor. Values are between 0.1 and 10.0.
Returns
number
doubleUnderline
Get Signature
get doubleUnderline(): boolean;
Gets a value indicating if the text is double underlined.
Returns
boolean
fillBrush
Get Signature
get fillBrush(): Brush;
Gets the brush to fill the glyphs.
Returns
font
Get Signature
get font(): Font;
Gets the Font used by this Format.
Returns
fontFamily
Get Signature
get fontFamily(): string;
Gets the font family name.
Returns
string
fontFeatures
Get Signature
get fontFeatures(): FontFeature[];
Gets the array of assigned Microsoft OpenType typography properties.
Returns
fontSize
Get Signature
get fontSize(): number;
Gets the logical font size, in graphic units.
Returns
number
foreColor
Get Signature
get foreColor(): Color;
Gets the text foreground color.
Returns
glyphAdvanceFactor
Get Signature
get glyphAdvanceFactor(): number;
Gets the scaling factor for the glyph advance value relative to font's Average Character Width. Values are from 0.5 up.
Returns
number
glyphAdvanceOffset
Get Signature
get glyphAdvanceOffset(): number;
Gets the absolute increment (delta) for the glyph advance value, in graphic units.
Returns
number
glyphWidths
Get Signature
get glyphWidths(): GlyphWidths;
Gets the preferred glyph widths (generally used in CJKV fonts).
Returns
hollow
Get Signature
get hollow(): boolean;
Gets a value indicating if the glyphs are hollow (outlined), otherwise they are solid.
Returns
boolean
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
italic
Get Signature
get italic(): boolean;
Gets a value indicating whether the font should be italicized.
Returns
boolean
language
Get Signature
get language(): string;
Gets the Neutral Culture string, if assigned.
Returns
string
lineGap
Get Signature
get lineGap(): number;
Gets the explicit line gap (if not null), in graphic units.
Returns
number
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
paletteIndex
Get Signature
get paletteIndex(): number;
Gets the index of a palette used for drawing color fonts.
Returns
number
recalcFontSizeForFallbackFonts
Get Signature
get recalcFontSizeForFallbackFonts(): boolean;
Gets a value indicating whether the size of a fallback font should be coerced to the size of original font.
Returns
boolean
sidewaysInVerticalText
Get Signature
get sidewaysInVerticalText(): boolean;
Gets a value indicating if all characters should appear as rotated 90 or -90 degrees in vertical text.
Returns
boolean
skipNormalization
Get Signature
get skipNormalization(): boolean;
Gets a value indicating whether the canonical decomposition, reordering, and composition stages should be omitted.
Returns
boolean
strictCanonicalDecomposition
Get Signature
get strictCanonicalDecomposition(): boolean;
Gets a value indicating whether to apply normalization to Singleton Decompositions and Post Composition Version precomposed characters.
Returns
boolean
strikethrough
Get Signature
get strikethrough(): boolean;
Gets a value indicating if the strikethrough style is applied to the text.
Returns
boolean
strokePen
Get Signature
get strokePen(): Pen;
Gets the pen to draw glyph outlines.
Returns
subscript
Get Signature
get subscript(): boolean;
Gets a value indicating if the glyphs should be displayed as subscript.
Returns
boolean
superscript
Get Signature
get superscript(): boolean;
Gets a value indicating if the glyphs should be displayed as superscript.
Returns
boolean
textRunAsCluster
Get Signature
get textRunAsCluster(): boolean;
Gets a value indicating whether the whole text run should be considered as a single Grapheme Cluster.
Returns
boolean
transformToFullWidth
Get Signature
get transformToFullWidth(): boolean;
Gets a value indicating if ASCII characters should be transformed into fullwidth characters.
Returns
boolean
transverseOffset
Get Signature
get transverseOffset(): number;
Gets the offset of the text in the orthogonal direction, in graphic units.
Returns
number
treatHyphenMinusAsHyphen
Get Signature
get treatHyphenMinusAsHyphen(): boolean;
Gets a value indicating whether the character 'HYPHEN-MINUS' (U+002D) is treated as the character 'HYPHEN' (U+2010) by the Unicode line breaking algorithm.
Returns
boolean
underline
Get Signature
get underline(): boolean;
Gets a value indicating if the text is underlined.
Returns
boolean
uprightInVerticalText
Get Signature
get uprightInVerticalText(): boolean;
Gets a value indicating if the normally sideways characters should be drawn upright in vertical text.
Returns
boolean
useHorizontalMetricsForVerticalText
Get Signature
get useHorizontalMetricsForVerticalText(): boolean;
Gets a value indicating if the horizontal ascending, descending, and line gap settings should be applied to vertical text.
Returns
boolean
useTypoMetrics
Get Signature
get useTypoMetrics(): boolean;
Gets a value indicating whether the typographical font metrics should be applied instead of Windows-specific and Apple-specific font metrics.
Returns
boolean
useVerticalLineGapForSideways
Get Signature
get useVerticalLineGapForSideways(): boolean;
Gets a value indicating that for sideways text in vertical flow, line gap will be set according to Font.verticalLineGap. If false, line gap for lines containing sideways text is set according to Font.horizontalLineGap, which can lead to different gaps between columns that contain sideways text runs and those that do not.
Returns
boolean
Methods
free()
free(): void;
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(omTo): void;
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void