TXTextControl.TextFrameCollection.GetItem Method

Gets a particular text frame from the collection.

Introduced: 15.1.

GetItem()

Gets the text frame selected by the user or null if no text frame is selected.

[C#]
public TextFrame GetItem();
[Visual Basic]
Public Function GetItem() As TextFrame

GetItem(Int32)

Gets the text frame with the specified identifier.

[C#]
public TextFrame GetItem(int id);
[Visual Basic]
Public Function GetItem(ByVal id As Integer) As TextFrame
Parameter Description
id

Specifies the text frame's identifier set with the ID property. The method returns null if a text frame with the specified identifier does not exist.

GetItem(String)

Gets the text frame with the specified name.

[C#]
public TextFrame GetItem(string name);
[Visual Basic]
Public Function GetItem(ByVal name As String) As TextFrame
Parameter Description
name

Specifies the text frame's name set with the Name property. The method returns null if a text frame with the specified name does not exist.

Return Value

The return value is null, if a text frame with the specified parameters could not be found. Otherwise, it is an object of the type TextFrame.

See Also