Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XTextRangeCompare

Base Interface
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.



Known Services which Export this Interface

com::sun::star::text::Text is an independent piece of text which consists of a series of one or more paragraphs.

Methods' Summary

compareRegionStarts
compareRegionEnds

Methods' Details

compareRegionStarts
 
short
compareRegionStarts(
[ in ] com::sun::star::text::XTextRange xR1,
[ in ] 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
 
short
compareRegionEnds(
[ in ] com::sun::star::text::XTextRange xR1,
[ in ] 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