[This is preliminary documentation and is subject to change.]

The constructor of the document information.

Namespace:  OfficeClip.BusinessLayer.Desktop
Assembly:  OfficeClip.BusinessLayer (in OfficeClip.BusinessLayer)
Version: 8.1.1.0

Syntax

C#
public DocumentInfo(
	int documentId,
	string documentName,
	string virtualPath,
	string documentPath,
	string active,
	int lockedByUserId,
	string lockedByUserName,
	int sharedByUserId,
	string sharedByUserName,
	int createdByUserId,
	string createdByUserName,
	DateTime createdDate,
	DateTime modifiedDate,
	int parentFolderId,
	int modifiedByUserId,
	string modifiedByUserName,
	string parentFolderName,
	string documentDescription,
	string documentKeyword,
	string appsDescription,
	double fileSize,
	int rev
)
Visual Basic (Declaration)
Public Sub New ( _
	documentId As Integer, _
	documentName As String, _
	virtualPath As String, _
	documentPath As String, _
	active As String, _
	lockedByUserId As Integer, _
	lockedByUserName As String, _
	sharedByUserId As Integer, _
	sharedByUserName As String, _
	createdByUserId As Integer, _
	createdByUserName As String, _
	createdDate As DateTime, _
	modifiedDate As DateTime, _
	parentFolderId As Integer, _
	modifiedByUserId As Integer, _
	modifiedByUserName As String, _
	parentFolderName As String, _
	documentDescription As String, _
	documentKeyword As String, _
	appsDescription As String, _
	fileSize As Double, _
	rev As Integer _
)
Visual C++
public:
DocumentInfo(
	int documentId, 
	String^ documentName, 
	String^ virtualPath, 
	String^ documentPath, 
	String^ active, 
	int lockedByUserId, 
	String^ lockedByUserName, 
	int sharedByUserId, 
	String^ sharedByUserName, 
	int createdByUserId, 
	String^ createdByUserName, 
	DateTime createdDate, 
	DateTime modifiedDate, 
	int parentFolderId, 
	int modifiedByUserId, 
	String^ modifiedByUserName, 
	String^ parentFolderName, 
	String^ documentDescription, 
	String^ documentKeyword, 
	String^ appsDescription, 
	double fileSize, 
	int rev
)

Parameters

documentId
Type: System..::.Int32
The system generated unique document id.
documentName
Type: System..::.String
The name of the document.
virtualPath
Type: System..::.String
The virtual path name.
documentPath
Type: System..::.String
Full real path name of the document.
active
Type: System..::.String
Shows if the document is Active.
lockedByUserId
Type: System..::.Int32
The user id of the user who locked this document.
lockedByUserName
Type: System..::.String
The user name of the user who locked this document.
sharedByUserId
Type: System..::.Int32
the user id of the user who has shared this document with somebody else
sharedByUserName
Type: System..::.String
The user name of the user who has shared the document with someone else.
createdByUserId
Type: System..::.Int32
The user id of the user who created the document.
createdByUserName
Type: System..::.String
The user name of the user who created the document.
createdDate
Type: System..::.DateTime
The created date of the document.
modifiedDate
Type: System..::.DateTime
The date when the document the document was last modified.
parentFolderId
Type: System..::.Int32
The id of the Parent folder for this document.
modifiedByUserId
Type: System..::.Int32
The user id of the user who modified the document last time.
modifiedByUserName
Type: System..::.String
The user name of the user who modified the document the last time.
parentFolderName
Type: System..::.String
The name of the Parent folder of this document.
documentDescription
Type: System..::.String
the Description that is associated with this document.
documentKeyword
Type: System..::.String
the keyword that is associated with this document.
appsDescription
Type: System..::.String
The Description of the document if this document is an application document, i.e. it is created by an application.
fileSize
Type: System..::.Double
The file size (in KB) for the document.
rev
Type: System..::.Int32
The revision of the document

See Also