Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

service RedlinePortion
Description
A RedlinePortion is a TextPortion that marks a change that has been recorded by the change tracking.

Included Services - Summary
TextPortion
(referenced entity's summary:)
A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside.
Properties' Summary
[ readonly ] string
RedlineAuthor
contains the name of the author of the change. 
[ readonly ] ::com::sun::star::util::DateTime
RedlineDateTime
contains the date and time of the change. 
[ readonly ] string
RedlineComment
contains a comment for the change. 
[ readonly ] string
RedlineType
contains the type of the change  
[ readonly ] ::com::sun::star::beans::PropertyValues
RedlineSuccessorData
contains the data of a second level redline data  
[ readonly ] string
RedlineIdentifier
contains a unique identifier for the redline. This is necessary for file export filters to able to recognize redline portions that point to the same redline. 
[ readonly ] boolean
IsInHeaderFooter
determines whether the portion is member of a header or footer text. 
[ readonly ] XText
RedlineText
provides access to the text of the redline. This interface is only provided if the change is not visible. The visibility depends on the redline display options that are set at the documents property set (RedlineDisplayType). 
[ readonly ] boolean
MergeLastPara
determines whether the last paragraph of a redline text has to be merged with a possible following text content (i.e. a text table) 
Included Services - Details
TextPortion
(referenced entity's summary:)
A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside.
Properties' Details
RedlineAuthor
[ readonly ] string RedlineAuthor;
Description
contains the name of the author of the change.
RedlineDateTime
[ readonly ] ::com::sun::star::util::DateTime RedlineDateTime;
Description
contains the date and time of the change.
RedlineComment
[ readonly ] string RedlineComment;
Description
contains a comment for the change.
RedlineType
[ readonly ] string RedlineType;
Description
contains the type of the change

Valid type names are:

  • Insert - marks an insertion

  • Delete - marks an deletion

  • Format - marks an attribute change

  • TextTable - marks a text table

  • Style - marks an applied style

RedlineSuccessorData
[ readonly ] ::com::sun::star::beans::PropertyValues RedlineSuccessorData;
Description
contains the data of a second level redline data

The elements of the sequence are:

  • string RedlineAuthor;

  • com::sun::star::util::DateTime RedlineDateTime;

  • string RedlineComment;

  • string RedlineType;

RedlineIdentifier
[ readonly ] string RedlineIdentifier;
Description
contains a unique identifier for the redline. This is necessary for file export filters to able to recognize redline portions that point to the same redline.
IsInHeaderFooter
[ readonly ] boolean IsInHeaderFooter;
Description
determines whether the portion is member of a header or footer text.
RedlineText
[ readonly ] XText RedlineText;
Description
provides access to the text of the redline. This interface is only provided if the change is not visible. The visibility depends on the redline display options that are set at the documents property set (RedlineDisplayType).
MergeLastPara
[ readonly ] boolean MergeLastPara;
Description
determines whether the last paragraph of a redline text has to be merged with a possible following text content (i.e. a text table)

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.