Skip to content
Howard edited this page Jan 11, 2017 · 8 revisions

Table of Contents

Viewing Properties

When you select the Properties tab, the properties for the current UNO object are displayed.

Name Value Type Value Info. Attr. Handle
CharFontName string Times New Roman Maybevoid
AvailableServiceNames []string -SEQUENCE- Pseud ReadOnly

For the property CharFontName: value type is "string", value is "Times New Roman", Info is "Maybevoid".

For AvailableServiceNames: value type of "[]string" means a sequence of strings (set and get with an array), value is "-SEQUENCE-" which means -type- value can not be converted to string, Info. is "Pseud" (see below).

Pseud Properties

Pseud means: false or artificial. If the selected language supports the pseud-property, then the code is generated with a pseud-property call.

Unlike a normal property a Pseud property is mapped by introspection. A Pseud property is created from a method having a "get", "set" and/or an "is" prefix.

For example, the getArgs method is mapped to the Args property and it is a pseud property. Pseud properties do not have entries in com.sun.star.beans.XPropertySet interface, therefore, you can not to get these property values through the XPropertySet interface, (i.e. getPropertyValue and setPropertyValue methods can not be used to get or set these property values).

If both a getXXX method and a setXXX method exists then the XXX pseud-property is readable and writable. But if only the getXXX method is supported, then the property is read-only, and if only the setXXX method is supported, then it is write-only.

A Pseud property depends on the language you write your macro in.

MRI uses XPropertySet interface of the target to get its property values, therefore, values of pseud properties are not able to get. However pseud properties are used frequently in codes. Therefore MRI calls the base method of the pseud property when you call a pseud property in the convenient purpose.

If you want to know more about Attributes, see com.sun.star.beans.PropertyAttribute constants group. (http://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1beans_1_1PropertyAttribute.html)

Notation Legends

Sometimes MRI shows special notations in the type, value and information of a property.

For type

Type Description
[]type Sequence of value type

For value

Value Description
"" Empty string.
-void No value.
-UPPERCASE- Value could not be converted to the string type.
-Error- Error raised during to get its value.

For Pseud or other information

Information Description
Pseud Pseud property.

Couldn't get value.
Ignored Listed in the ignored list of properties.
Attr. Interface Attribute(s).

If a property string has a CR or LF they are replaced by "\r" and "\n".

Long texts are abbreviated.

Viewing a Property value

When Menu "Mode" is "Get", if you double click a property you see it's value displayed. MRI shows the value according to the properties' type class.

Setting a Property Value

When Menu "Mode" is "Set", you can set a numerical, string, enum or boolean type properties' value.

When you double click a writable property and one that is either numerical, string, enum or boolean, then the property setting dialog box appears. You can then enter a new property value which is converted to an appropriate type for the property when you save it.

A boolean type is converted as follows: 1 or true --> True, 0, false and all else --> False.

If the property is pseud property, the method corresponding to the property is called. (See Methods Needing Arguments section about calling a method.)

When you set a property value, MRI reloads the property information and tries to keep the carret position and scrolled value of the information edit.

Modifier Keys

You can also get or set property values by double clicking on the information edit. Use Ctrl and Alt keys as modifiers:

Key Description
Ctrl Suppress actions caused by double clickings.
Alt Temporary, change the mode Get to Set or Set to Get.
Clone this wiki locally