Function tip_GetFirstAnnotatedTextRange


Prototype: tip_GetFirstAnnotatedTextRange(Annotation);
Arguments:

Text: The text object indexed by the Annotation. (CDM_ByteSequence)
Annotation: The Annotation that indexes the text range. (CDM_Annotation)


Prototype: tip_GetFirstAnnotatedTextRange(Document);
Arguments:

Document: The Document object. (CDM_Document)
Annotation: The Annotation that indexes the text range. (CDM_Annotation)

C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

tip_GetFirstAnnotatedTextRange(Annotation):
This function will return a the text range from the provided Text object that is annotated by the first span of the provided Annotation. In simple words, this function will retrieve the first span from the provided Annotation and return the text range (from the specified text object) that is indexed by this span.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

tip_GetFirstAnnotatedTextRange(Document):
This function will return a the text range from the text of the specified Document object that is annotated by the first span of the provided Annotation. In simple words, this function will retrieve the first span from the provided Annotation and return the text range (from the text of the specified Document object) that is indexed by this span.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. (In this case an empty object will be returned.)

Return Value:

tip_GetFirstAnnotatedTextRange(Annotation):
This function returns a ByteSequence/RawData object (of type CDM_ByteSequence or CDM_RawData) containing the text range (or portion) from the "Text" object indexed by the first span of the "Annotation" parameter.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. In this case an empty object (i.e. one containing the string "") will be returned.)

tip_GetFirstAnnotatedTextRange(Document):
This function returns a ByteSequence/RawData object (of type CDM_ByteSequence or CDM_RawData) containing the text range (or portion) from the text contained in the "Document" object indexed by the first span of the "Annotation" parameter.

Note that this function will always create and return a new object, even when the Annotations has an empty span set. In this case an empty object (i.e. one containing the string "") will be returned.)

Notes:

tip_GetFirstAnnotatedTextRange(Annotation):
Note that usually the provided text object is the text of a Document, retrieved through calls to either CDM_GetByteSequence or CDM_GetRawData. The text object is expected to contain text in Unicode or UTF-8 representation.

This function is equivelant to CDM_GetFirstAnnotatedTextRange (C++ API).

tip_GetFirstAnnotatedTextRange(Document):
This function is equivelant to CDM_GetFirstAnnotatedTextRange (C++ API).

See Also:

tip_GetFirstAnnotatedTextRange(Annotation):
tip_GetByteSequence, tip_GetRawData, Tcl_DecrRefCount, tip_Free, tip_GetAnnotatedTextRanges

tip_GetFirstAnnotatedTextRange(Document):
tip_GetByteSequence, tip_GetRawData, Tcl_DecrRefCount, tip_Free, tip_GetAnnotatedTextRanges


Generated by: petasis@aias on Wed Aug 16 10:31:45 PM EEST 2006.