LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Public Attributes | List of all members
BaseFrameProperties Service Referencepublished

specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles. More...

import"BaseFrameProperties.idl";

Inheritance diagram for BaseFrameProperties:
UserDefinedAttributesSupplier BaseFrame TextEmbeddedObject TextFrame TextGraphicObject ChainedTextFrame

Included Services

service com::sun::star::xml::UserDefinedAttributesSupplier
 gives access to the UserDefinedAttributes property. More...
 

Public Attributes

short AnchorPageNo
 contains the number of the page where the objects are anchored. More...
 
com::sun::star::text::XTextFrame AnchorFrame
 contains the text frame the current frame is anchored to. More...
 
com::sun::star::util::Color BackColor
 contains the color of the background of the object. More...
 
string BackGraphicURL
 contains the URL for the background graphic. More...
 
string BackGraphicFilter
 contains the name of the file filter for the background graphic. More...
 
com::sun::star::style::GraphicLocation BackGraphicLocation
 determines the position of the background graphic. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains the left border of the object. More...
 
com::sun::star::table::BorderLine RightBorder
 contains the right border of the object. More...
 
com::sun::star::table::BorderLine TopBorder
 contains the top border of the object. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains the bottom border of the object. More...
 
long BorderDistance
 contains the distance from the border to the object. More...
 
long LeftBorderDistance
 contains the distance from the left border to the object. More...
 
long RightBorderDistance
 contains the distance from the right border to the object. More...
 
long TopBorderDistance
 contains the distance from the top border to the object. More...
 
long BottomBorderDistance
 contains the distance from the bottom border to the object. More...
 
boolean BackTransparent
 If TRUE, the "BackColor" is ignored. More...
 
boolean ContentProtected
 determines if the content is protected. More...
 
long LeftMargin
 contains the left margin of the object. More...
 
long RightMargin
 contains the right margin of the object. More...
 
long TopMargin
 contains the top margin of the object. More...
 
long BottomMargin
 contains the bottom margin of the object. More...
 
long Height
 contains the height of the object (1/100 mm). More...
 
long Width
 contains the width of the object (1/100 mm). More...
 
short RelativeHeight
 contains the relative height of the object. More...
 
short RelativeWidth
 contains the relative width of the object. More...
 
boolean IsSyncWidthToHeight
 determines whether the width follows the height. More...
 
boolean IsSyncHeightToWidth
 determines whether the height follows the width. More...
 
short HoriOrient
 determines the horizontal orientation of the object. More...
 
long HoriOrientPosition
 contains the horizontal position of the object (1/100 mm). More...
 
short HoriOrientRelation
 determines the environment of the object to which the orientation is related. More...
 
short VertOrient
 determines the vertical orientation of the object. More...
 
long VertOrientPosition
 contains the vertical position of the object (1/100 mm). More...
 
short VertOrientRelation
 determines the environment of the object to which the orientation is related. More...
 
string HyperLinkURL
 contains the URL of a hyperlink that is set at the object. More...
 
string HyperLinkTarget
 contains the name of the target for a hyperlink that is set at the object. More...
 
string HyperLinkName
 contains the name of the hyperlink that is set at the object. More...
 
boolean Opaque
 determines if the object is opaque or transparent for text. More...
 
boolean PageToggle
 determines if the object is mirrored on even pages. More...
 
boolean PositionProtected
 determines if the position is protected. More...
 
boolean Print
 determines if the object is included in printing. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 contains the type of the shadow of the object. More...
 
boolean ServerMap
 determines if the object gets an image map from a server. More...
 
com::sun::star::awt::Size Size
 contains the size of the object. More...
 
boolean SizeProtected
 determines if the size is protected. More...
 
com::sun::star::text::WrapTextMode Surround
 determines the type of the surrounding text. More...
 
boolean SurroundAnchorOnly
 determines if the text of the paragraph in which the object is anchored, wraps around the object. More...
 
short WrapInfluenceOnPosition
 determines the influence of the text wrap on the positioning of the shape More...
 
com::sun::star::awt::Size LayoutSize
 returns the actual size of the object. More...
 
string Title
 contains short title for the object More...
 
string Description
 contains description for the object More...
 
com::sun::star::drawing::FillStyle FillStyle
 This enumeration selects the style the area will be filled with. More...
 
com::sun::star::awt::Gradient FillGradient
 If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More...
 
string FillGradientName
 If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the gradient used. More...
 
short ShadowTransparence
 This defines the degree of transparence of the shadow in percent. More...
 
sequence< com::sun::star::beans::PropertyValueFrameInteropGrabBag
 Grab bag of frame properties, used as a string-any map for interim interop purposes. More...
 
short RelativeHeightRelation
 contains the relation of the relative height of the object. More...
 
short RelativeWidthRelation
 contains the relation of the relative width of the object. More...
 
com::sun::star::graphic::XGraphic BackGraphic
 contains the graphic for the background. More...
 

Additional Inherited Members

- Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 

Detailed Description

specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles.

Exported Interfaces

gives access to the UserDefinedAttributes property.

Since
OOo 2.1

Member Data Documentation

com::sun::star::text::XTextFrame AnchorFrame
property

contains the text frame the current frame is anchored to.

The value is valid only if the AnchorType is TextContentAnchorType::AT_FRAME.

short AnchorPageNo
property

contains the number of the page where the objects are anchored.

The value is valid only if the AnchorType is TextContentAnchorType::AT_PAGE.

com::sun::star::util::Color BackColor
property

contains the color of the background of the object.

com::sun::star::graphic::XGraphic BackGraphic
optionalproperty

contains the graphic for the background.

Since
LibreOffice 6.1
string BackGraphicFilter
property

contains the name of the file filter for the background graphic.

com::sun::star::style::GraphicLocation BackGraphicLocation
property

determines the position of the background graphic.

string BackGraphicURL
property

contains the URL for the background graphic.

Deprecated:
as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

boolean BackTransparent
property

If TRUE, the "BackColor" is ignored.

long BorderDistance
property

contains the distance from the border to the object.

com::sun::star::table::BorderLine BottomBorder
property

contains the bottom border of the object.

See also
BaseFrame::com::sun::star::table::BorderLine
long BottomBorderDistance
property

contains the distance from the bottom border to the object.

long BottomMargin
property

contains the bottom margin of the object.

boolean ContentProtected
property

determines if the content is protected.

string Description
optionalproperty

contains description for the object

The long description text can be entered to describe a object in more detail to users with screen reader software. The description is visible as an alternative tag for accessibility tools.

Since
OOo 3.2
com::sun::star::awt::Gradient FillGradient
optionalproperty

If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used.

Since
LibreOffice 4.1
string FillGradientName
optionalproperty

If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the gradient used.

Since
LibreOffice 4.1
com::sun::star::drawing::FillStyle FillStyle
optionalproperty

This enumeration selects the style the area will be filled with.

Currently only set for gradients.

Since
LibreOffice 4.1
sequence<com::sun::star::beans::PropertyValue> FrameInteropGrabBag
optionalproperty

Grab bag of frame properties, used as a string-any map for interim interop purposes.

Since
LibreOffice 4.2

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

long Height
property

contains the height of the object (1/100 mm).

It is only valid if TextEmbeddedObject::RelativeHeight is zero.

short HoriOrient
property

determines the horizontal orientation of the object.

See also
BaseFrame::HoriOrientation
long HoriOrientPosition
property

contains the horizontal position of the object (1/100 mm).

It is only valid if "HoriOrient" is HoriOrientation_NONE.

short HoriOrientRelation
property

determines the environment of the object to which the orientation is related.

See also
BaseFrame::RelOrientation
string HyperLinkName
property

contains the name of the hyperlink that is set at the object.

string HyperLinkTarget
property

contains the name of the target for a hyperlink that is set at the object.

string HyperLinkURL
property

contains the URL of a hyperlink that is set at the object.

boolean IsSyncHeightToWidth
property

determines whether the height follows the width.

boolean IsSyncWidthToHeight
property

determines whether the width follows the height.

com::sun::star::awt::Size LayoutSize
optionalpropertymaybevoid

returns the actual size of the object.

Since to obtain the correct actual size of the object not only the layouting for the frame needs to be finished but the whole document needs to be formatted as well. Thus if that was not done previously it may take some while to retrieve this value.

Since
OOo 2.0.4
com::sun::star::table::BorderLine LeftBorder
property

contains the left border of the object.

See also
BaseFrame::com::sun::star::table::BorderLine
long LeftBorderDistance
property

contains the distance from the left border to the object.

long LeftMargin
property

contains the left margin of the object.

boolean Opaque
property

determines if the object is opaque or transparent for text.

boolean PageToggle
property

determines if the object is mirrored on even pages.

boolean PositionProtected
property

determines if the position is protected.

boolean Print
property

determines if the object is included in printing.

short RelativeHeight
property

contains the relative height of the object.

It is only valid if it is greater than zero.

short RelativeHeightRelation
optionalproperty

contains the relation of the relative height of the object.

It is only valid if RelativeHeight is greater than zero.

See also
com::sun::star::text::RelOrientation
Since
LibreOffice 4.3
short RelativeWidth
property

contains the relative width of the object.

It is only valid if it is greater than zero.

short RelativeWidthRelation
optionalproperty

contains the relation of the relative width of the object.

It is only valid if RelativeWidth is greater than zero.

See also
com::sun::star::text::RelOrientation
Since
LibreOffice 4.3
com::sun::star::table::BorderLine RightBorder
property

contains the right border of the object.

See also
BaseFrame::com::sun::star::table::BorderLine
long RightBorderDistance
property

contains the distance from the right border to the object.

long RightMargin
property

contains the right margin of the object.

boolean ServerMap
property

determines if the object gets an image map from a server.

com::sun::star::table::ShadowFormat ShadowFormat
property

contains the type of the shadow of the object.

short ShadowTransparence
optionalproperty

This defines the degree of transparence of the shadow in percent.

This is the same as setting the Color member of the ShadowFormat property to an ARGB color.

Since
LibreOffice 4.2

contains the size of the object.

See also
BaseFrame::Height
BaseFrame::Width
boolean SizeProtected
property

determines if the size is protected.

determines the type of the surrounding text.

Deprecated:
boolean SurroundAnchorOnly
property

determines if the text of the paragraph in which the object is anchored, wraps around the object.

string Title
optionalproperty

contains short title for the object

This short title is visible as an alternative tag in HTML format. Accessibility tools can read this text.

Since
OOo 3.2

contains the top border of the object.

See also
BaseFrame::com::sun::star::table::BorderLine
long TopBorderDistance
property

contains the distance from the top border to the object.

long TopMargin
property

contains the top margin of the object.

short VertOrient
property

determines the vertical orientation of the object.

See also
BaseFrame::VertOrientation
long VertOrientPosition
property

contains the vertical position of the object (1/100 mm).

It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE.

short VertOrientRelation
property

determines the environment of the object to which the orientation is related.

See also
BaseFrame::RelOrientation
long Width
property

contains the width of the object (1/100 mm).

It is only valid if TextEmbeddedObject::RelativeWidth is zero.

short WrapInfluenceOnPosition
optionalproperty

determines the influence of the text wrap on the positioning of the shape

The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos is TRUE. Valid values are given by WrapInfluenceOnPosition

Since
OOo 2.0

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