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

SystemObject
  Atalasoft.PdfDoc.Generating.ShapesPdfBaseShape
    Atalasoft.PdfDoc.Generating.ShapesPdfBaseTextShape
      Atalasoft.PdfDoc.Generating.ShapesPdfClippedTextLine

Namespace: Atalasoft.PdfDoc.Generating.Shapes
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class PdfClippedTextLine : PdfBaseTextShape

<SerializableAttribute>
Public Class PdfClippedTextLine
	Inherits PdfBaseTextShape

The PdfClippedTextLine type exposes the following members.

Constructors

	Name	Description
	PdfClippedTextLine(String, String, PdfBounds, PdfFontManager)	Initializes a new instance of the PdfClippedTextLine class while intelligently figuring out fontsize and positioning.
	PdfClippedTextLine(String, String, Double, PdfPoint, PdfBounds)	Initializes a new instance of the PdfClippedTextLine class.

Top

Properties

	Name	Description
	Alignment	Gets or sets the alignment. (Inherited from PdfBaseTextShape.)
	Clip	Gets or sets a value indicating whether this PdfBaseShape shape will clip. (Inherited from PdfBaseShape.)
	ClipBounds	Gets or sets the clip bounds.
	FillColor	Gets or sets the color of the fill. (Inherited from PdfBaseShape.)
	FontName	Gets or sets the name of the font. (Inherited from PdfBaseTextShape.)
	FontSize	Gets or sets the size of the font. (Inherited from PdfBaseTextShape.)
	HorizontalScaling	Gets or sets the horizontal scaling. (Inherited from PdfBaseTextShape.)
	Location	Gets or sets the location. (Inherited from PdfBaseShape.)
	Name	Gets or sets the name of the IPdfRenderable object. (Inherited from PdfBaseShape.)
	OutlineColor	Gets or sets the color of the outline. (Inherited from PdfBaseShape.)
	RenderMode	Gets or sets the render mode. (Inherited from PdfBaseTextShape.)
	Rotation	Gets or sets the rotation in degrees. (Inherited from PdfBaseShape.)
	Scale	Gets or sets the scale. (Inherited from PdfBaseShape.)
	Style	Gets or sets the style. (Inherited from PdfBaseShape.)
	Text	Gets or sets the text.
	WordSpacing	Gets or sets the word spacing. (Inherited from PdfBaseTextShape.)

Top

Methods

	Name	Description
	Clone	Creates a new object that is a copy of the current instance. (Inherited from PdfBaseShape.)
	CloneInstance	Clones the instance. (Overrides PdfBaseTextShapeCloneInstance.)
	CopyBaseShapePropertiesTo	Copies the base shape properties to the parameter shape. (Inherited from PdfBaseShape.)
	DrawShape	Draws the shape. (Overrides PdfBaseTextShapeDrawShape(PdfPageRenderer).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GenerateTransform	Generates the default transform based on Scale, Rotate, and Translate. (Inherited from PdfBaseShape.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTextStartOffset(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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyResourceRenamed	Notifies a resource consumer that a resource was renamed. (Inherited from PdfBaseShape.)
	OnResourceRenamed	Called when a resource in the shape has been renamed. (Inherited from PdfBaseTextShape.)
	OnResourcesRequested	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.)
	Render	Generates the PDF display list objects. (Overrides PdfBaseTextShapeRender(PdfPageRenderer).)
	ResourcesUsed	Reports a list of all resources consumed by the object of the given class. (Inherited from PdfBaseShape.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Examples

Copy

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);
}

Reference

Atalasoft.PdfDoc.Generating.Shapes Namespace