TXTextControl.Image Class

An instance of the Image class represents an image in a Text Control document. The TextControl class has several events that inform about different occurrences.

Syntax

[C#]
public class Image : FrameBase
[Visual Basic]
Public Class Image
  Inherits FrameBase

Constructors

Constructor Description
Image Overloaded. Initializes a new instance of the Image class.

Properties

Property Description
Alignment Gets or sets the frame's horizontal alignment when it is anchored to a paragraph. (Inherited from FrameBase.)
ExportCompressionQuality Sets a value between 1 and 100, which is the quality of a lossy data compression used if this image is saved.
ExportFileName Gets or sets the file name of an image used, if a Text Control document is saved.
ExportFilterIndex Gets or sets the format used if an image is saved.
ExportMaxResolution Gets or sets the maximum resolution in dots per inch used if this image is saved.
FileName Gets or sets the corresponding file name and path from which an inserted image is loaded.
FilterIndex Gets or sets the format used, if an image is inserted.
HorizontalScaling Gets or sets an images's horizontal scaling factor in percent.
ID Gets or sets an identifier for the frame. (Inherited from FrameBase.)
InsertionMode (Only for compatibility) Gets or sets a value determining whether an image is treated as a single character or the document's text either flows around or overwrites the image.
InsertionMode Gets or sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. (Inherited from FrameBase.)
Location Gets or sets, in twips, the frame's current location. (Inherited from FrameBase.)
Moveable Determines whether a frame can be moved in the document at run time with the built-in mouse interface. (Inherited from FrameBase.)
Name Gets or sets a name for the frame. (Inherited from FrameBase.)
SaveMode Determines whether the image is stored through its data or through its file reference.
Size Gets or sets the frame's size in twips. (Inherited from FrameBase.)
Sizeable Determines whether the frame can be resized at run time with the built-in mouse interface. (Inherited from FrameBase.)
TextDistances Gets or sets the distances, in twips, between the frame and the document's text. (Inherited from FrameBase.)
TextPosition Read only. Gets the frame's character position in the document's text (one-based). (Inherited from FrameBase.)
VerticalScaling Gets or sets an images's vertical scaling factor in percent.

Methods

Method Description
ChangeZOrder Changes the frame's z-order. (Inherited from FrameBase.)

Example

The following example inserts a new image into the document, which will be treated as a character. The image's size will be reduced to 75% and it will not be sizeable:

[C#]
TXTextControl.Image myImage = new TXTextControl.Image();
myImage.Sizeable = false;
myImage.HorizontalScaling = 75;
myImage.VerticalScaling = 75;

textControl1.Images.Add(myImage, -1);
[Visual Basic]
Dim MyImage As New TXTextControl.Image()
MyImage.Sizeable = False
MyImage.HorizontalScaling = 75
MyImage.VerticalScaling = 75

TextControl1.Images.Add(MyImage, -1)

See Also