TextObject Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class represents a text object.
Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FixedLayout.ResourcesResourceContext
    Shape
      Apitron.PDF.Kit.FixedLayout.ContentTextObject

Namespace:  Apitron.PDF.Kit.FixedLayout.Content
Assembly:  Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax

public sealed class TextObject : Shape

The TextObject type exposes the following members.

Constructors

  NameDescription
Public methodTextObject
Initializes a new instance of the TextObject class. Font will be used from the graphics state.
Public methodCode exampleTextObject(String, Double)
Initializes a new instance of the TextObject class.
Public methodCode exampleTextObject(StandardFonts, Double)
Initializes a new instance of the TextObject class.
Top
Properties

  NameDescription
Public propertyText
Gets the text of the object.
Top
Methods

  NameDescription
Public methodCode exampleAppendText
Appends the text.
Public methodCode exampleAppendTextLine(String)
Appends the text on the next line. Next line will be calculated using current text leading (SetTextLeading(Double)).
Public methodCode exampleAppendTextLine(Double, Double, String)
Appends the text on the next line and sets word and char spacings. Next line will be calculated using current text leading (SetTextLeading(Double)).
Public methodCode exampleAppendTextWithPositions(Object)
Appends the text with positions. Show one or more text strings, allowing individual glyph positioning. Each element of array shall be either a string or a number. If the element is a string, this operator shall show the string. If it is a number, the operator shall adjust the text position by that amount; that is, it shall translate the text matrix. The number shall be expressed in thousandths of a unit of text space. This amount shall be subtracted from the current horizontal or vertical coordinate, depending on the writing mode. In the default coordinate system, a positive adjustment has the effect of moving the next glyph painted either to the left or down by the given amount.
Public methodCode exampleAppendTextWithPositions(String, Double)
Appends the text with positions. Show one or more text strings, allowing individual glyph positioning. Each element of array shall be either a string or a number. If the element is a string, this operator shall show the string. If it is a number, the operator shall adjust the text position by that amount; that is, it shall translate the text matrix. The number shall be expressed in thousandths of a unit of text space. This amount shall be subtracted from the current horizontal or vertical coordinate, depending on the writing mode. In the default coordinate system, a positive adjustment has the effect of moving the next glyph painted either to the left or down by the given amount.
Public methodStatic memberIsRTL
Determines whether the specified text direction is RTL.
Public methodCode exampleMoveToNextLine
Move to the start of the next line, offset from the start of the current line by current leading.
Public methodCode exampleMoveToNextLine(Double, Double)
Move to the start of the next line, offset from the start of the current line by (tx, ty). tx and ty shall denote numbers expressed in unscaled text space units.
Public methodCode exampleMoveToNextLineAndSetLeading
Moves to next line and as a side effect sets the leading .
Public methodCode exampleSetCharacterSpacing
Sets the character spacing.
Public methodSetDeviceNonStrokingColor
Sets the device color as a current non stroking color. The number of array elements determines the colour space in which the colour shall be defined: 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
Public methodSetDeviceStrokingColor
Sets the device color as a current stroking color. The number of array elements determines the colour space in which the colour shall be defined: 1 DeviceGray 3 DeviceRGB 4 DeviceCMYK
Public methodCode exampleSetFont(String, Double)
Sets the current font.
Public methodCode exampleSetFont(StandardFonts, Double)
Sets one of the standarcd fonts as a current font.
Public methodCode exampleSetHorizontalScaling
Sets the horizontal scaling.
Public methodCode exampleSetNonStrokingColor(Double)
Sets the current color for the non stroking operations.
Public methodCode exampleSetNonStrokingColor(String, Double)
Sets the current color for the non stroking operations.
Public methodCode exampleSetNonStrokingColorSpace
Sets the non strking color space.
Public methodSetRotation
Sets the current text matrix using alpha. Equivalent of call SetTextMatrix(Math.Cos(alpha), Math.Sin(alpha), -Math.Sin(alpha), Math.Cos(alpha), 0, 0)
Public methodSetScale
Sets scale to the current text matrix.Equivalent of call SetTextMatrix(xScale, 0, 0, yScale, 0, 0)
Public methodSetSkew
Sets the current text matrix using xAngle and yAngle. Equivalent of call SetTextMatrix(1, Math.Tan(xAlpha), Math.Tan(yAlpha), 1, 0, 0)
Public methodCode exampleSetStrokingColor(Double)
Sets the current color for the stroking operations.
Public methodCode exampleSetStrokingColor(String, Double)
Sets the current color for the stroking operations.
Public methodCode exampleSetStrokingColorSpace
Sets the stroking color space.
Public methodCode exampleSetTextLeading
Sets the text leading. It specifies the vertical distance between the baselines of adjacent lines of text.
Public methodCode exampleSetTextMatrix
Sets the current text matrix.
Public methodCode exampleSetTextRenderingMode
Sets the text rendering mode. Determines whether showing text causes glyph outlines to be stroked, filled or both.
Public methodCode exampleSetTextRise
Sets the text rise. It specifies the distance to move the baseline up or down from its default location. Positive values of text rise move the baseline up.
Public methodSetTranslation
Sets the current text matrix. Equivalent of call SetTextMatrix(1, 0, 0, 1, xOffset, yOffset)
Public methodCode exampleSetWordSpacing
Sets the word spacing.
Public methodToString
Returns a String that represents this instance.
(Overrides ObjectToString.)
Top
See Also

Reference