DocumentContainer gives access to manage documents. Documents can be used in projects (Project). More...

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

Public Member Functions
override Document	GetChild (DocumentInfo documentInfo)
	Gets a Document based on a DocumentInfo. More...

Document	GetDocument (DocumentInfo documentInfo)
	This method is deprecated. Please use GetChild(DocumentInfo) instead. More...

DocumentInfo	CreateDocument (string name, string suffix, DocumentType type, Stream content)
	Creates a document with the specific name, suffix, type and content. More...

void	DeleteDocument (DocumentInfo documentInfo)
	Deletes a document specified by an info object. More...

override DocumentInfo	CopyFrom (ICoreInfo coreInfo)
	Copies a document from another container. More...

override DocumentInfo	RefreshChild (DocumentInfo childInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
void	DisposeChild (ICoreObject coreObject)

bool	IsParentOf (ICoreObject coreObject)

abstract TChildInfo	RefreshChild (TChildInfo childInfo)

void	RefreshChildren ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual IEnumerable< TChild >	GetChildren (IEnumerable< TChildInfo > childrenInfos=null)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo childInfo)

virtual void	DeleteChild (TChildInfo childInfo)

virtual OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	MoveFrom (ICoreInfo coreInfo)

virtual OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	CopyFrom (ICoreInfo coreInfo)

Protected Member Functions
override IEnumerable< DocumentInfo >	GetChildrenInfos ()
	Gets the children infos.

virtual Document	CreateNewInstance (Guid coreObjectId, DocumentInfo documentInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId, bool ownsObject=true)

TChildInfo	RefreshChild (Predicate< TChildInfo > predicate, object childInformation)
	Refreshes all infos and returns the appropriate info. More...

virtual void	RefreshChildren (bool clearEvents)

Properties
ICoreObjectWithDocuments	Parent `[get]`

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

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
IList< TChildInfo >	ChildrenInfos

Detailed Description

DocumentContainer gives access to manage documents. Documents can be used in projects (Project).

Member Function Documentation

override DocumentInfo Ofcas.Lk.Api.Client.Core.DocumentContainer.CopyFrom ( ICoreInfo coreInfo )

Copies a document from another container.

Parameters

coreInfo Specifies the document.

DocumentInfo Ofcas.Lk.Api.Client.Core.DocumentContainer.CreateDocument	(	string	name,
		string	suffix,
		DocumentType	type,
		Stream	content
	)

Creates a document with the specific name, suffix, type and content.

Parameters

name	Specifies the name of the document.
suffix	Specifies the suffix of the document.
type	Specifies the type of the document.
content	Specifies the content of the document.

void Ofcas.Lk.Api.Client.Core.DocumentContainer.DeleteDocument ( DocumentInfo documentInfo )

Deletes a document specified by an info object.

Parameters

documentInfo Specifies the document to be deleted.

override Document Ofcas.Lk.Api.Client.Core.DocumentContainer.GetChild ( DocumentInfo documentInfo )

Parameters

documentInfo The DocumentInfo of the Document to be returned.

Document Ofcas.Lk.Api.Client.Core.DocumentContainer.GetDocument ( DocumentInfo documentInfo )

This method is deprecated. Please use GetChild(DocumentInfo) instead.

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