LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Included Services | Exported Interfaces | Public Attributes | List of all members
TextPortion Service Referencepublished

A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside. More...

import "TextPortion.idl";

Inheritance diagram for TextPortion:
TextRange XContentEnumerationAccess XTolerantMultiPropertySet XInterface XInterface ParagraphPropertiesComplex ParagraphPropertiesAsian ParagraphProperties CharacterPropertiesComplex CharacterPropertiesAsian CharacterProperties XContentEnumerationAccess XPropertyState XPropertySet XTextRange RedlinePortion

Included Services

service ::com::sun::star::text::TextRange
 
- Included Services inherited from TextRange
service com::sun::star::style::CharacterProperties
 
service com::sun::star::style::CharacterPropertiesAsian
 
service com::sun::star::style::CharacterPropertiesComplex
 
service com::sun::star::style::ParagraphProperties
 
service com::sun::star::style::ParagraphPropertiesAsian
 
service com::sun::star::style::ParagraphPropertiesComplex
 

Exported Interfaces

interface ::com::sun::star::container::XContentEnumerationAccess
 contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character. More...
 
interface ::com::sun::star::beans::XTolerantMultiPropertySet
 gives access to a sequence of properties. More...
 
- Exported Interfaces inherited from TextRange
interface com::sun::star::text::XTextRange
 
interface com::sun::star::beans::XPropertySet
 
interface com::sun::star::beans::XPropertyState
 
interface com::sun::star::container::XContentEnumerationAccess
 

Public Attributes

string TextPortionType
 contains the type of the text portion. More...
 
short ControlCharacter
 contains the control character of a text portion of type ControlCharacter. More...
 
::com::sun::star::text::XTextContent Bookmark
 contains the bookmark of a text portion of type Bookmark. More...
 
::com::sun::star::text::XTextContent DocumentIndexMark
 contains the document index mark of a text portion of type DocumentIndexMark. More...
 
::com::sun::star::text::XTextContent ReferenceMark
 contains the bookmark of a text portion of type ReferenceMark. More...
 
::com::sun::star::text::XFootnote Footnote
 contains the footnote of a text portion of type Footnote. More...
 
::com::sun::star::text::XTextField TextField
 contains the text field of a text portion of type TextField. More...
 
::com::sun::star::text::XTextContent InContentMetadata
 contains the text range of a text portion of type InContentMetadata. More...
 
boolean IsCollapsed
 contains whether the portion is a point only. More...
 
boolean IsStart
 contains whether the portion is the start of the portion. More...
 

Additional Inherited Members

- Public Member Functions inherited from XTextRange
XText getText ()
 
XTextRange getStart ()
 
XTextRange getEnd ()
 
string getString ()
 
void setString ([in] string aString)
 the whole string of characters of this piece of text is replaced. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName,[in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence
< com::sun::star::beans::PropertyState
getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XContentEnumerationAccess
com::sun::star::container::XEnumeration createContentEnumeration ([in] string aServiceName)
 
sequence< string > getAvailableServiceNames ()
 
- Protected Member Functions inherited from XTolerantMultiPropertySet
sequence
< com::sun::star::beans::SetPropertyTolerantFailed
setPropertyValuesTolerant ([in] sequence< string > aPropertyNames,[in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence
< com::sun::star::beans::GetPropertyTolerantResult
getPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence
< com::sun::star::beans::GetDirectPropertyTolerantResult
getDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 
- Protected Attributes inherited from CharacterPropertiesAsian
float CharHeightAsian
 This value contains the height of the characters in point. More...
 
float CharWeightAsian
 This property contains the value of the font weight. More...
 
string CharFontNameAsian
 This property specifies the name of the font style. More...
 
string CharFontStyleNameAsian
 This property contains the name of the font style. More...
 
short CharFontFamilyAsian
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetAsian
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchAsian
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureAsian
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleAsian
 contains the value of the locale. More...
 
- Protected Attributes inherited from CharacterPropertiesComplex
float CharHeightComplex
 This value contains the height of the characters in point. More...
 
float CharWeightComplex
 This property contains the value of the font weight. More...
 
string CharFontNameComplex
 This property specifies the name of the font style. More...
 
string CharFontStyleNameComplex
 This property contains the name of the font style. More...
 
short CharFontFamilyComplex
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetComplex
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchComplex
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureComplex
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleComplex
 contains the value of the locale. More...
 
- Protected Attributes inherited from ParagraphPropertiesAsian
boolean ParaIsHangingPunctuation
 determines if hanging punctuation is allowed. More...
 
boolean ParaIsCharacterDistance
 determines if a distance between Asian text, western text or complex text is set. More...
 
boolean ParaIsForbiddenRules
 determines if the rules for forbidden characters at the start or end of text lines are considered. More...
 
- Protected Attributes inherited from ParagraphPropertiesComplex
short WritingMode
 contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants More...
 

Detailed Description

A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside.

It is created by an enumeration implemented in a paragraph service. It may be used to export the content of the paragraph to an external document format.

See Also
com::sun::star::text::TextPortionEnumeration
com::sun::star::text::XTextPortionEnumeration
Developers Guide
Text - Iterating over Text
Text - Formatting

Exported Interfaces

Exported Interfaces

gives access to a sequence of properties.

Since
OOo 2.0

contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character.

See Also
com.sun.star.text.TextFrame
com.sun.star.text.TextGraphicObject

Member Data Documentation

::com::sun::star::text::XTextContent Bookmark
optionalpropertyreadonly

contains the bookmark of a text portion of type Bookmark.

short ControlCharacter
propertyreadonly

contains the control character of a text portion of type ControlCharacter.

Deprecated:
type ControlCharacter no longer implemented

contains the document index mark of a text portion of type DocumentIndexMark.

::com::sun::star::text::XFootnote Footnote
optionalpropertyreadonly

contains the footnote of a text portion of type Footnote.

contains the text range of a text portion of type InContentMetadata.

Since
OOo 3.2
boolean IsCollapsed
optionalpropertyreadonly

contains whether the portion is a point only.

boolean IsStart
optionalpropertyreadonly

contains whether the portion is the start of the portion.

This is used for portions which are represented by 2 TextPortion objects (e.g., DocmentIndexMark).

contains the bookmark of a text portion of type ReferenceMark.

::com::sun::star::text::XTextField TextField
optionalpropertyreadonly

contains the text field of a text portion of type TextField.

string TextPortionType
propertyreadonly

contains the type of the text portion.

Valid content type names are:

Text
string content
TextField
a text field
TextContent
text content - supplied via the interface com::sun::star::container::XContentEnumerationAccess
ControlCharacter
a control character
Footnote
a footnote or an endnote
ReferenceMark
a reference mark
DocumentIndexMark
a document index mark
Bookmark
a bookmark
Redline
a redline portion which is a result of the change tracking feature
Ruby
a ruby attribute which is used in Asian text
Frame
a frame
SoftPageBreak
a soft page break
InContentMetadata
a text range with attached metadata

For Reference marks, document index marks, etc., 2 text portions will be generated, one for the start position and one for the end position.


The documentation for this service was generated from the following file: