Micro Focus Content Manager SDK 9.4
Public Member Functions | List of all members
HP.HPTRIM.SDK.ITrimUserFields Interface Reference

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

Inheritance diagram for HP.HPTRIM.SDK.ITrimUserFields:
HP.HPTRIM.SDK.Activity HP.HPTRIM.SDK.ArchiveEvent HP.HPTRIM.SDK.CheckinStyle HP.HPTRIM.SDK.Classification HP.HPTRIM.SDK.Consignment HP.HPTRIM.SDK.ExternalWorkflow HP.HPTRIM.SDK.Hold HP.HPTRIM.SDK.Keyword HP.HPTRIM.SDK.Location HP.HPTRIM.SDK.Meeting HP.HPTRIM.SDK.MeetingType HP.HPTRIM.SDK.Record HP.HPTRIM.SDK.Request HP.HPTRIM.SDK.Schedule HP.HPTRIM.SDK.SecurityGuide HP.HPTRIM.SDK.Space HP.HPTRIM.SDK.TodoItem HP.HPTRIM.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

UserFieldValue HP.HPTRIM.SDK.ITrimUserFields.GetFieldValue ( FieldDefinition  userFieldType)

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

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

string HP.HPTRIM.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 HP.HPTRIM.SDK.Record, HP.HPTRIM.SDK.Location, HP.HPTRIM.SDK.Activity, HP.HPTRIM.SDK.Classification, HP.HPTRIM.SDK.MeetingType, HP.HPTRIM.SDK.Workflow, HP.HPTRIM.SDK.Consignment, HP.HPTRIM.SDK.CheckinStyle, HP.HPTRIM.SDK.Space, HP.HPTRIM.SDK.Request, HP.HPTRIM.SDK.Schedule, HP.HPTRIM.SDK.ArchiveEvent, HP.HPTRIM.SDK.Meeting, HP.HPTRIM.SDK.Hold, HP.HPTRIM.SDK.TodoItem, HP.HPTRIM.SDK.ExternalWorkflow, HP.HPTRIM.SDK.SecurityGuide, and HP.HPTRIM.SDK.Keyword.

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

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

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