Function tip_AnnotationsContaining


Prototype: tip_AnnotationsContaining(Document);
Arguments:

Document: A Document object. (CDM_Document)
Position: Position in text. (int)


Prototype: tip_AnnotationsContaining(Annotation);
Arguments:

Document: A Document object. (CDM_Document)
Position: Position in text. (int)


Prototype: tip_AnnotationsContaining(Document);
Arguments:

Document: A Document object. (CDM_Document)
Position1: Position in text. (int)
Position2: Position in text. (int)


Prototype: tip_AnnotationsContaining(Annotation);
Arguments:

Document: A Document object. (CDM_Document)
Position1: Position in text. (int)
Position2: Position in text. (int)


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

Description:

tip_AnnotationsContaining(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 include the specified text position (as given by the parameter "Position") into their spans.

This function will always create and return a new Annotation set object, even when the Document has no Annotations defined or when no Annotation is found that includes the specified text position into its span. (In this case an empty Annotation set will be returned.)

In case of an error, an error message will be prompted.

tip_AnnotationsContaining(Annotation):
This function will return a new Annotation set object (of type CDM_AnnotationSet) that will contain all the Annotations of the specified Document that include the specified text positions (as given by the parameters "Position1" and "Position2") into their spans.

This function will always create and return a new Annotation set object, even when the Document has no Annotations defined or when no Annotation is found that includes the specified text position into its span. (In this case an empty Annotation set will be returned.)

In case of an error, an error message will be prompted.

tip_AnnotationsContaining(Document):

tip_AnnotationsContaining(Annotation):

Return Value:

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

If an error occurs, an error message will be prompted.

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

If an error occurs, an error message will be prompted.

tip_AnnotationsContaining(Document):

tip_AnnotationsContaining(Annotation):

Notes:

tip_AnnotationsContaining(Document):
This function is equivelant to CDM_AnnotationsContaining (C++ API).

tip_AnnotationsContaining(Annotation):
This function is equivelant to CDM_AnnotationsContaining (C++ API).

tip_AnnotationsContaining(Document):

tip_AnnotationsContaining(Annotation):

See Also:

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

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

tip_AnnotationsContaining(Document):

tip_AnnotationsContaining(Annotation):


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