interface XTextRangeCompare in module com::sun::star::text::

(Global Index)

Syntax

interface XTextRangeCompare : com::sun::star::uno::XInterface ;

Description

compares the positions of two TextRange s within a Text .

Only TextRange instances within the same Text can be compared.

Method Summary

compareRegionStarts

compareRegionEnds

Known Services Which Export this Interface

com::sun::star::text::Text

Method Details



compareRegionStarts

Syntax

short compareRegionStarts (
com::sun::star::text::XTextRange xR1,
com::sun::star::text::XTextRange xR2 )
raises ( com::sun::star::lang::IllegalArgumentException );

Returns

1 if xR1 starts before xR2 , 0 if xR1 starts at the same position as xR2 and -1 if xR1 starts behind xR2 .

Throws

com::sun::star::lang::IllegalArgumentException if either xR1 or xR2 is not within this text.

compareRegionEnds

Syntax

short compareRegionEnds (
com::sun::star::text::XTextRange xR1,
com::sun::star::text::XTextRange xR2 )
raises ( com::sun::star::lang::IllegalArgumentException );

Returns

1, if xR1 ends before xR2 , 0, if xR1 ends at the same position as xR2 and -1, if xR1 ends behind xR2 .

Throws

com::sun::star::lang::IllegalArgumentException if either xR1 or xR2 is not within this text.
Top of Page