AquaLogic Interaction Development Kit (IDK) 6.0.0

IContentItem.SetTextBlockPropertyValue Method 

Updates the value of the ITextBlockProperty.

void SetTextBlockPropertyValue(
   IBaseProperty textBlockProperty,
   string value
);

Parameters

textBlockProperty
The ITextBlockProperty; cannot be null.
value
The new value for the property; cannot be null.

Remarks

This method takes in an HTML string, which can be written manually or obtained using a Rich Text Control tool.

For example, in order to generate the text below:

"Hello World"

where "World" is in black and bolded, the HTML string can be set as follow:

textBlockProperty.SetTextBlockProperty("Hello <strong><font color=\"#000000\">World</font></strong>");

An InvalidOperationException will be thrown if this method is called on an item that is not checked out. The updated property value will not be persisted until IContentItemManager.CheckInItem is called. If the content item does not contain the specified property, an ArgumentException will be thrown when IContentItemManager.CheckInItem is called.

See the code sample in IContentItem class documentation for an example of how to modify a property value of different types.

Exceptions

Exception TypeCondition
InvalidOperationException The item has already been removed or the item is not checked out.
ArgumentException The item does not contain the specified property.

See Also

IContentItem Interface | Plumtree.Remote.PRC.Content.Item Namespace | CheckInItem