The class Document is the represenation of a LogiKal document. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.Document:

Public Member Functions
void	GetContent (Stream target)
	The content from the document. More...

OperationInfo	CanEdit (string key, object value)

DocumentInfo	Edit (string key, object value)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
bool	CanDispose ()
	Returns the information about whether the object can be deleted. An object can only be deleted if no children live. More...

IList< Guid >	Children ()
	Returns a list with CoreObjectId for all children More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Disposable
void	Dispose ()

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< DocumentInfo >
OperationInfo	CanEdit (string key, object value)
	Checks whether Edit can be executed with given parameters. More...

TOwnInfo	Edit (string key, object value)
	Edits this object with given parameters. More...

Properties
DocumentContainer	Parent `[get]`

DocumentInfo	CoreInfo `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
Guid	CoreObjectId `[get]`
	The unique identifier of the object instance. More...

DocumentContainer	Documents `[get]`
	Returns the DocumentContainer to handle documents to the object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< DocumentContainer >
TParent	Parent `[get]`
	The parent of this object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< DocumentInfo >
TOwnInfo	CoreInfo `[get]`
	The own info of this object. More...

Additional Inherited Members
Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
	CoreObjectBase (IApiService apiService, Guid coreObjectId)

override void	Dispose (bool disposing)

virtual void	OnSynchronizedEventReceived (ISynchronizedEvent synchronizedEvent)
	Gets called when a synchronized event was received. More...

void	RaiseIfFailed (BaseResponse response, [CallerMemberName] string callerMethod=null)
	Raises an ApiException if the stated BaseResponse indicates a failure. More...

Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
readonly IApiService	_apiService

Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< Disposable >	Disposed

Detailed Description

The class Document is the represenation of a LogiKal document.

Member Function Documentation

void Ofcas.Lk.Api.Client.Core.Document.GetContent ( Stream target )

The content from the document.

Parameters

target The content from the document is written in this stream. If the document has no content, the lenght of target is zero.

Exceptions

Exception If getting the document content failed.

The documentation for this class was generated from the following file: