LibreOffice: Rule Struct Reference

LibreOffice LibreOffice 7.4 SDK API Reference

Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
Rule Struct Referencepublished

describes a rule that can be applies to a number of objects. More...

## Public Types
typedef sequence< com::sun::star::ucb::RuleTerm > | Terms
| the rule terms describing the objects to which the rule should be applied.

## Public Attributes
string | Parameter
| Some RuleActions require a parameter.
short | Action
| the action to perform on the matching objects.

## Detailed Description

describes a rule that can be applies to a number of objects.

A rule consists of a sequence of RuleTerms describing the objects to which the rule should be applied, the RuleAction which should be used on the matching objects, and a parameter.

## Member Typedef Documentation

## ◆ Terms

sequence<com::sun::star::ucb::RuleTerm> Terms

the rule terms describing the objects to which the rule should be applied.

## Member Data Documentation

## ◆ Action

short Action

the action to perform on the matching objects.

The value can be one of the RuleAction constants.

## ◆ Parameter

string Parameter

Some RuleActions require a parameter.

Action | Parameter
--- | ---
COPY, MOVE, LINK | The URL to the destination folder.
FORWARD | The email address of the recipient
All other actions | n/a

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

- com/sun/star/ucb/Rule.idl