ImageCollection Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. Core. SDK
- Assembly
TXTextControl.Core. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. Core. SDK TXTextControl.from the setup.dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.dll
- Inherits
- Frame
Base Collection - Image
Collection
- Frame
- Implements
- ICollection, IEnumerable
Description
An instance of the ImageCollection class contains all images in a Text Control document or part of the document represented through objects of the type Image. An instance of this class can be obtained with the TextControl.Images, HeaderFooter.Images or TextFrame.Images property. The ImageCollection class implements the IEnumerable and the ICollection interfaces.
Syntax
public sealed class ImageCollection : FrameBaseCollectionPublic NotInheritable Class ImageCollection
Inherits FrameBaseCollectionExamples
The following example iterates all images and sets the Image.SaveMode to SaveAsFileReference, so that all images will be exported the next time the document is saved. The images, will be saved in a subfolder called "'document name'_Images" of the location where the document has been saved to. The additional properties can be used to set the image's quality, format and maximum resolution.
foreach (TXTextControl.Image myImage in textControl1.Images)
{
myImage.SaveMode = TXTextControl.ImageSaveMode.SaveAsFileReference;
myImage.ExportCompressionQuality = 100; //Export with maximum quality
myImage.ExportFilterIndex = 4; //Export as PNG format
myImage.ExportMaxResolution = 96; //Export with 96 DPI max
}For Each MyImage As TXTextControl.Image In TextControl1.Images
MyImage.SaveMode = TXTextControl.ImageSaveMode.SaveAsFileReference
MyImage.ExportCompressionQuality = 100 'Export with maximum quality
MyImage.ExportFilterIndex = 3 'Export as PNG
MyImage.ExportMaxResolution = 96 'Export with 96 DPI max
NextThe following example works with images in the current document.
ImageCollection imageCollection = textControl.Images;
imageCollection.Add(new TXTextControl.Image { FileName = @"Images\company-logo.png", Name = "CompanyLogo" }, -1);Dim imageCollection As ImageCollection = textControl.Images
imageCollection.Add(New TXTextControl.Image With { .FileName = "Images\company-logo.png", .Name = "CompanyLogo" }, -1)Members
Properties
| Property | Description |
|---|---|
| Count | Gets the number of elements contained in the collection. (Inherited from FrameBaseCollection.) |
| ExportFilters | Gets all available filters for exporting images. This property can be used to set the FileDialog.Filter property. |
| ImportFilters | Gets all available filters for importing images. This property can be used to set the FileDialog.Filter property. |
| 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 |
|---|---|
| Add | Inserts a new image in a Text Control document. |
| 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 from the collection. |
| Remove | Removes an image from a Text Control document. |