HP.HPTRIM.SDK.ITrimDocument Interface Reference

Allows you to access attach, detach and extract a document associated with a Trim object More...

Inheritance diagram for HP.HPTRIM.SDK.ITrimDocument:

Public Member Functions
void	SetDocument (string fromFileName)
	Set the document associated with this Trim object as a copy of the supplied file name More...
void	LoadDocumentIntoClientCache ()
	Loads the document associated with this object into the client document cache, if one is available. More...
string	GetDocumentPathInClientCache (Events logAccessAs)
	Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type. More...

Properties
bool	IsDocumentInClientCache [get]
	Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache. More...
string	DocumentPathInClientCache [get]
	Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'. More...

Detailed Description

Allows you to access attach, detach and extract a document associated with a Trim object

Member Function Documentation

string HP.HPTRIM.SDK.ITrimDocument.GetDocumentPathInClientCache

(

Events

logAccessAs

)

Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type.

Implemented in HP.HPTRIM.SDK.Record, HP.HPTRIM.SDK.Origin, HP.HPTRIM.SDK.MeetingType, HP.HPTRIM.SDK.AgendaItem, HP.HPTRIM.SDK.OfflineRecord, HP.HPTRIM.SDK.MinuteItem, HP.HPTRIM.SDK.ConsignmentApprover, HP.HPTRIM.SDK.RecordRendition, HP.HPTRIM.SDK.AgendaItemType, HP.HPTRIM.SDK.RecordSapComponent, HP.HPTRIM.SDK.WorkingCopy, HP.HPTRIM.SDK.LocationEAddress, HP.HPTRIM.SDK.RecordRevision, HP.HPTRIM.SDK.Report, HP.HPTRIM.SDK.RecordLinkedDocument, HP.HPTRIM.SDK.ReportBitmap, and HP.HPTRIM.SDK.MinuteItemType.

void HP.HPTRIM.SDK.ITrimDocument.LoadDocumentIntoClientCache

(

)

Loads the document associated with this object into the client document cache, if one is available.

Implemented in HP.HPTRIM.SDK.Record, HP.HPTRIM.SDK.Origin, HP.HPTRIM.SDK.MeetingType, HP.HPTRIM.SDK.AgendaItem, HP.HPTRIM.SDK.OfflineRecord, HP.HPTRIM.SDK.MinuteItem, HP.HPTRIM.SDK.ConsignmentApprover, HP.HPTRIM.SDK.RecordRendition, HP.HPTRIM.SDK.AgendaItemType, HP.HPTRIM.SDK.RecordSapComponent, HP.HPTRIM.SDK.WorkingCopy, HP.HPTRIM.SDK.LocationEAddress, HP.HPTRIM.SDK.RecordRevision, HP.HPTRIM.SDK.Report, HP.HPTRIM.SDK.RecordLinkedDocument, HP.HPTRIM.SDK.ReportBitmap, and HP.HPTRIM.SDK.MinuteItemType.

void HP.HPTRIM.SDK.ITrimDocument.SetDocument

(

string

fromFileName

)

Set the document associated with this Trim object as a copy of the supplied file name

Implemented in HP.HPTRIM.SDK.Record, HP.HPTRIM.SDK.Origin, HP.HPTRIM.SDK.MeetingType, HP.HPTRIM.SDK.AgendaItem, HP.HPTRIM.SDK.OfflineRecord, HP.HPTRIM.SDK.MinuteItem, HP.HPTRIM.SDK.ConsignmentApprover, HP.HPTRIM.SDK.RecordRendition, HP.HPTRIM.SDK.AgendaItemType, HP.HPTRIM.SDK.RecordSapComponent, HP.HPTRIM.SDK.WorkingCopy, HP.HPTRIM.SDK.LocationEAddress, HP.HPTRIM.SDK.RecordRevision, HP.HPTRIM.SDK.Report, HP.HPTRIM.SDK.RecordLinkedDocument, HP.HPTRIM.SDK.ReportBitmap, and HP.HPTRIM.SDK.MinuteItemType.

Property Documentation

string HP.HPTRIM.SDK.ITrimDocument.DocumentPathInClientCache

get

Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'.

bool HP.HPTRIM.SDK.ITrimDocument.IsDocumentInClientCache

get

Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache.