FrameCollection Class — TX Text Control .NET for Windows Forms

Description

An instance of the FrameCollection class contains all images, text frames and charts in a document. The collection consists of objects of the types Image, TextFrame, ChartFrame and BarcodeFrame. An instance of this class can be obtained with the TextControl.Frames, WPF.TextControl.Frames and ServerTextControl.Frames properties. The FrameCollection class implements the IEnumerable and the ICollection interfaces.

Syntax

public sealed class FrameCollection : FrameBaseCollection

Public NotInheritable Class FrameCollection
    Inherits FrameBaseCollection

Examples

The following example works with frames in the current document.

FrameCollection frameCollection = textControl.Frames;
TextFrame callout = new(new System.Drawing.Size(3000, 1200)) { Name = "Callout" };
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText);

Dim frameCollection As FrameCollection = textControl.Frames
Dim callout As New TextFrame(New System.Drawing.Size(3000, 1200)) With { .Name = "Callout" }
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText)

Members

Properties

Property	Description
Count	Gets the number of elements contained in the collection. (Inherited from FrameBaseCollection.)
IsSynchronized	Returns true if the collection is designed to be thread safe, otherwise, it returns false. (Inherited from FrameBaseCollection.)
SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from FrameBaseCollection.)

Methods

Method	Description
Clear	Removes all objects from the collection and from the document. (Inherited from FrameBaseCollection.)
CopyTo	Copies the elements of the collection to an array, starting at a particular index.
GetEnumerator	Returns an enumerator that can be used to iterate through the collection. (Inherited from FrameBaseCollection.)
GetItem	Gets a particular image, text frame, chart, barcode or drawing from the collection.
Remove	Removes a frame (image, text frame, chart, barcode or drawing) from a document.