Click or drag to resize

PdfClippedTextLine Class

A pdf text object which writes text and clips to a rectangle. This object is best used to make spreadsheet like trimming of long strings to fit into a cell of a table.
Inheritance Hierarchy

Namespace:  Atalasoft.PdfDoc.Generating.Shapes
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class PdfClippedTextLine : PdfBaseTextShape

The PdfClippedTextLine type exposes the following members.

Constructors
  NameDescription
Public methodPdfClippedTextLine(String, String, PdfBounds, PdfFontManager)
Initializes a new instance of the PdfClippedTextLine class while intelligently figuring out fontsize and positioning.
Public methodPdfClippedTextLine(String, String, Double, PdfPoint, PdfBounds)
Initializes a new instance of the PdfClippedTextLine class.
Top
Properties
  NameDescription
Public propertyAlignment
Gets or sets the alignment.
(Inherited from PdfBaseTextShape.)
Public propertyClip
Gets or sets a value indicating whether this PdfBaseShape shape will clip.
(Inherited from PdfBaseShape.)
Public propertyClipBounds
Gets or sets the clip bounds.
Public propertyFillColor
Gets or sets the color of the fill.
(Inherited from PdfBaseShape.)
Public propertyFontName
Gets or sets the name of the font.
(Inherited from PdfBaseTextShape.)
Public propertyFontSize
Gets or sets the size of the font.
(Inherited from PdfBaseTextShape.)
Public propertyHorizontalScaling
Gets or sets the horizontal scaling.
(Inherited from PdfBaseTextShape.)
Public propertyLocation
Gets or sets the location.
(Inherited from PdfBaseShape.)
Public propertyName
Gets or sets the name of the IPdfRenderable object.
(Inherited from PdfBaseShape.)
Public propertyOutlineColor
Gets or sets the color of the outline.
(Inherited from PdfBaseShape.)
Public propertyRenderMode
Gets or sets the render mode.
(Inherited from PdfBaseTextShape.)
Public propertyRotation
Gets or sets the rotation in degrees.
(Inherited from PdfBaseShape.)
Public propertyScale
Gets or sets the scale.
(Inherited from PdfBaseShape.)
Public propertyStyle
Gets or sets the style.
(Inherited from PdfBaseShape.)
Public propertyText
Gets or sets the text.
Public propertyWordSpacing
Gets or sets the word spacing.
(Inherited from PdfBaseTextShape.)
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from PdfBaseShape.)
Protected methodCloneInstance
Clones the instance.
(Overrides PdfBaseTextShapeCloneInstance.)
Public methodCopyBaseShapePropertiesTo
Copies the base shape properties to the parameter shape.
(Inherited from PdfBaseShape.)
Protected methodDrawShape
Draws the shape.
(Overrides PdfBaseTextShapeDrawShape(PdfPageRenderer).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGenerateTransform
Generates the default transform based on Scale, Rotate, and Translate.
(Inherited from PdfBaseShape.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTextStartOffset(Double, Double)
Gets the text start offset for a line of text. This is used to align text based on the alignment.
(Inherited from PdfBaseTextShape.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNotifyResourceRenamed
Notifies a resource consumer that a resource was renamed.
(Inherited from PdfBaseShape.)
Protected methodOnResourceRenamed
Called when a resource in the shape has been renamed.
(Inherited from PdfBaseTextShape.)
Protected methodOnResourcesRequested
Called when the PdfBaseShape is requested to report resources used. If client code consumes resources, it should override this method combining its results with those of base.OnResourceRequested
(Inherited from PdfBaseTextShape.)
Public methodRender
Generates the PDF display list objects.
(Overrides PdfBaseTextShapeRender(PdfPageRenderer).)
Public methodResourcesUsed
Reports a list of all resources consumed by the object of the given class.
(Inherited from PdfBaseShape.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Examples
for(int i=0; i < 5;i++)
{
    PdfClippedTextLine line = new PdfClippedTextLine(TextValues[i], new PdfBounds(100*i,200,100,50), doc.GlobalResources.Fonts); 
    doc.DisplayList.Add(line);
}
See Also