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

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

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

Public Member Functions inherited from Ofcas.Lk.Api.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.Core.Disposable
void	Dispose ()

Public Attributes
DocumentContainer	Parent => (DocumentContainer)ParentCore
	Parent of this object. More...

Additional Inherited Members
Protected Member Functions inherited from Ofcas.Lk.Api.Core.CoreObjectBase
override void	Dispose (bool disposing)

	CoreObjectBase (IApiService apiService, Guid coreObjectId)

	CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent)

	CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent, ICoreInfo coreInfo)

Protected Attributes inherited from Ofcas.Lk.Api.Core.CoreObjectBase
IApiService	_apiService = null

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

Guid	ParentCoreObjectId `[get]`
	The unique identifier from the parent object instance More...

ICoreInfo	CoreInfo `[get, protected set]`
	Holds the included informations to the current object More...

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

Properties inherited from Ofcas.Lk.Api.Core.Disposable
bool	IsDisposed `[get]`

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

Detailed Description

The class Document is the represenation of a LogiKal document.

Member Function Documentation

void Ofcas.Lk.Api.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.

DocumentContainer Ofcas.Lk.Api.Core.Document.Parent => (DocumentContainer)ParentCore

Parent of this object.

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