Function tip_AnnotationsInRange
|
|
Prototype: | tip_AnnotationsInRange(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_AnnotationsInRange(Annotation);
|
---|
Arguments: | Document: A Document object. (CDM_Document) Start: The start of the desired range. (int) End: The end of the desired range. (int)
|
---|
|
|
Description:
tip_AnnotationsInRange(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 within 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 be prmpted.
tip_AnnotationsInRange(Annotation): |
Return Value:
tip_AnnotationsInRange(Document): |
This function returns an Annotation set object (of type
CDM_AnnotationSet). If an error occurs, an error message will be prmpted.
tip_AnnotationsInRange(Annotation): |
Notes:
tip_AnnotationsInRange(Document): |
This function is equivelant to CDM_AnnotationsInRange (C++ API). tip_AnnotationsInRange(Annotation): |
See Also:
tip_AnnotationsInRange(Document): |
tip_AnnotationsAt, tip_AnnotationsContaining,
tip_AnnotationsMatchingRange, tip_Free,
Tcl_DecrRefCount tip_AnnotationsInRange(Annotation): |
Generated by: petasis@aias on Wed Aug 16 10:31:45 PM EEST 2006.