Function tip_AnnotationsMatchingRange


Prototype: tip_AnnotationsMatchingRange(Document);
Arguments:

Document: A Document object. (CDM_Document)
Start: The start of the desired range. (int)
End: The end of the desired range. (int)


Prototype: tip_AnnotationsMatchingRange(Annotation);
Arguments:

Document: A Document object. (CDM_Document)
Start: The start of the desired range. (int)
End: The end of the desired range. (int)

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

Description:

tip_AnnotationsMatchingRange(Document):
This function will return a new Annotation set object (of type CDM_AnnotationSet) that will contain all the Annotations of the specified Document that have at least one span that exactly matches the specified range (["Start", "End"]).

This function will always create and return a new AnnotationSet object, even when the Document has no Annotations defined or when no Annotation is found that resides inside the specified range. (In this case an empty Annotation set will be returned.)

In case of an error, an error message will prompt.

tip_AnnotationsMatchingRange(Annotation):

Return Value:

tip_AnnotationsMatchingRange(Document):
This function returns an Annotation set object (of type CDM_AnnotationSet).

If an error occurs, an error message will prompt.

tip_AnnotationsMatchingRange(Annotation):

Notes:

tip_AnnotationsMatchingRange(Document):
This function is equivelant to CDM_AnnotationsMatchingRange (C++ API).

tip_AnnotationsMatchingRange(Annotation):

See Also:

tip_AnnotationsMatchingRange(Document):
tip_AnnotationsAt, tip_AnnotationsContaining, tip_AnnotationsInRange, tip_Free, Tcl_DecrRefCount

tip_AnnotationsMatchingRange(Annotation):


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