Micro Focus Content Manager SDK 10.1
Public Member Functions | List of all members
TRIM.SDK.ITrimUserFields Interface Reference

Allows you to retrieve and set values for user-defined fields associated with a Trim Object More...

Inheritance diagram for TRIM.SDK.ITrimUserFields:
TRIM.SDK.Activity TRIM.SDK.ArchiveEvent TRIM.SDK.CheckinStyle TRIM.SDK.Classification TRIM.SDK.Consignment TRIM.SDK.ConsignmentTemplate TRIM.SDK.ExternalWorkflow TRIM.SDK.Hold TRIM.SDK.Keyword TRIM.SDK.Location TRIM.SDK.Meeting TRIM.SDK.MeetingType TRIM.SDK.Record TRIM.SDK.Request TRIM.SDK.Schedule TRIM.SDK.SecurityGuide TRIM.SDK.Space TRIM.SDK.TodoItem TRIM.SDK.Workflow

Public Member Functions

UserFieldValue GetFieldValue (FieldDefinition userFieldType)
 Gets the value of the nominated user-defined field for this object. More...
 
void SetFieldValue (FieldDefinition userFieldType, UserFieldValue newFieldValue)
 Sets the value of the nominated user-defined field for this object. More...
 
string GetFieldValueAsString (FieldDefinition userFieldType, StringDisplayType fieldValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a user-defined field value in a format appropriate for a specific use. More...
 

Detailed Description

Allows you to retrieve and set values for user-defined fields associated with a Trim Object

Member Function Documentation

◆ GetFieldValue()

UserFieldValue TRIM.SDK.ITrimUserFields.GetFieldValue ( FieldDefinition  userFieldType)

Gets the value of the nominated user-defined field for this object.

Implemented in TRIM.SDK.Workflow, TRIM.SDK.TodoItem, TRIM.SDK.Space, TRIM.SDK.SecurityGuide, TRIM.SDK.Schedule, TRIM.SDK.Request, TRIM.SDK.Record, TRIM.SDK.MeetingType, TRIM.SDK.Meeting, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Hold, TRIM.SDK.ExternalWorkflow, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, TRIM.SDK.CheckinStyle, TRIM.SDK.ArchiveEvent, and TRIM.SDK.Activity.

◆ GetFieldValueAsString()

string TRIM.SDK.ITrimUserFields.GetFieldValueAsString ( FieldDefinition  userFieldType,
StringDisplayType  fieldValueStringType,
bool  useHTMLEscapeChars 
)

Gets a string representation of a user-defined field value in a format appropriate for a specific use.

Implemented in TRIM.SDK.Workflow, TRIM.SDK.TodoItem, TRIM.SDK.Space, TRIM.SDK.SecurityGuide, TRIM.SDK.Schedule, TRIM.SDK.Request, TRIM.SDK.Record, TRIM.SDK.MeetingType, TRIM.SDK.Meeting, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Hold, TRIM.SDK.ExternalWorkflow, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, TRIM.SDK.CheckinStyle, TRIM.SDK.ArchiveEvent, and TRIM.SDK.Activity.

◆ SetFieldValue()

void TRIM.SDK.ITrimUserFields.SetFieldValue ( FieldDefinition  userFieldType,
UserFieldValue  newFieldValue 
)

Sets the value of the nominated user-defined field for this object.

Implemented in TRIM.SDK.Workflow, TRIM.SDK.TodoItem, TRIM.SDK.Space, TRIM.SDK.SecurityGuide, TRIM.SDK.Schedule, TRIM.SDK.Request, TRIM.SDK.Record, TRIM.SDK.MeetingType, TRIM.SDK.Meeting, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Hold, TRIM.SDK.ExternalWorkflow, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, TRIM.SDK.CheckinStyle, TRIM.SDK.ArchiveEvent, and TRIM.SDK.Activity.