LibreOffice
LibreOffice 25.8 SDK API Reference
Loading...
Searching...
No Matches
Rule Struct Referencepublished

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

import "Rule.idl";

Public Types

typedef sequence< com::sun::star::ucb::RuleTermTerms
 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

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.

ActionParameter
COPY, MOVE, LINKThe URL to the destination folder.
FORWARDThe email address of the recipient
All other actionsn/a

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