RDOUserProperty object

 

RDOUserProperty represents a custom user property defined on an Outlook item .

 

Returned by:

RDOUserProperties.Item / Find

 

The example below create a new task and adds a new user property of type olFormula.

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
Set task = Session.GetDefaultFolder(olFolderTasks).Items.add
task.TotalWork = 3000
task.Subject = "Test task with a user property"
Set Prop = task.UserProperties.Add("TotalWork", olFormula)
Prop.Formula = "[Total Work]"
Prop.ValidationFormula = ">= 2400"
Prop.ValidationText = "Total work must be greater than 2400"
task.Save

 

Properties

Methods

 


Derived from: IDispatch


Properties


Formula

Returns or sets a String representing the formula for the user property. Read/write.

 

 

IsUserProperty

Returns the type of the user property. TRUE for thee custom properties, FALSE for the built-in properties (such as Subject - see RDOUserProperties.Find).

 

 

Name

Returns a String representing the name of the user property. Read-only.

 

 

Printable

Boolean, read/write. If TRUE (by default) the property name and value will be printed along with the message header contents

 

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Msg = Session.GetDefaultFolder(olFolderDrafts).Items.Add("IPM.Note")
Msg.Subject = "Non-printable property"
set Prop = Msg.UserProperties.Add("Non-printable Property", olText)
Prop.Value = "This value won't be printed"
Prop.Printable = false

Msg.Save
set Msg = Session.GetDefaultFolder(olFolderDrafts).Items.Add("IPM.Note")
Msg.Subject = "Printable property"
set Prop = Msg.UserProperties.Add("Printable Property", olText)
Prop.Value = "This value will be printed"
Prop.Printable = true

Msg.Save

 

Required

Boolean, read/write. If TRUE and the property is missing or empty, Outlook UI and Object Model will display an error message when the message is saved.

The default value is FALSE.

 

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Msg = Session.GetDefaultFolder(olFolderDrafts).Items.Add("IPM.Note")
Msg.Subject = "Required property"
set Prop = Msg.UserProperties.Add("Required Property", olText)
Prop.Value = "If empty or missing, you won't be able to save this message from Outlook UI"
Prop.Required = true

Msg.Save

 

Type

Returns an rdoUserPropertyType constant indicating the type of the specified object. Read-only.

 

olText (0x1)
olNumber (0x3)
olDateTime (0x5)
olYesNo (0x6)
olDuration (0x7)
olKeywords (0xB)
olPercent (0xC)
olCurrency (0xE)
olFormula (0x12)
olCombination (0x13)

olInteger (0x14)

 

 

ValidationFormula

Returns or sets a String indicating the validation formula for the user property. Read/write.

 

 

ValidationText

Returns or sets a String specifying the validation text for the specified user property. Read/write.

 

 

Value

Returns or sets a Variant indicating the value for the specified custom property. Read/write.

 

 


Methods


Delete

Deletes the user property.