FileObject Class

Namespace: bcpDevKit.Entities.Vault
Assembly: bcpDevKit.dll

Syntax

public class FileObject

Properties

Type

Name

Description

../../../../_images/prop.ico FolderObject

Folder

Parent Folder

../../../../_images/prop.ico string

Name

../../../../_images/prop.ico string

Hidden

Use SetFileHidden(bool hidden) to set this value.

../../../../_images/prop.ico string

Classification

Use SetFileClassification(FileClassification fileClass) to set this value.

../../../../_images/prop.ico string

Category

../../../../_images/prop.ico ACLObject

AClObjects

../../../../_images/prop.ico List<FileRevision>

Revisions

../../../../_images/prop.ico FileTypeEnum

FileType

Use SetFileType() to set this value automatically.

../../../../_images/prop.ico Nullable<ACLBehavior>

AclBehavior

../../../../_images/prop.ico ACLBehavior

AclBehaviorSerialized

../../../../_images/prop.ico FileRevision

LatestRevision

Gets latest revision.

../../../../_images/prop.ico FileIteration

LatestIteration

Get latest iteration of latest revision.

../../../../_images/prop.ico FileIterationRef

LatestIterationRef

Get latest iterationref of latest revision.

Methods

Type

Name

Description

../../../../_images/method.ico void

SetFileHidden(bool hidden)

../../../../_images/method.ico void

SetFileClassification(FileClassification fileClass)

../../../../_images/method.ico void

SetAsPreview(bool preview)

When true, sets Hidden to true and Classification to FileClassification.DesignVisualization.

../../../../_images/method.ico FileClassification

GetFileClassification()

../../../../_images/method.ico void

SetFileType()

Sets FileType Property depending on file ending.

../../../../_images/method.ico FileRevision

AddRevisionWithIteration(string fileLocation, string label = “”)

Creates and returns a new FileRevision with a FileIteration

../../../../_images/method.ico FileRevision

AddRevisionWithIterationRef(long checksum, DateTime createDate, string label = “”)

Creates and returns a new FileRevision with a FileIterationRef

../../../../_images/method.ico ACLObject

AddAcl()

../../../../_images/method.ico FolderObject

GetFolder()

Get parent Folder.

../../../../_images/method.ico void

OrderRevisions()

Orders revisions by their label.

../../../../_images/method.ico bool

ShouldSerializeAclBehaviorSerialized()

Returns true if ACLBehaviour is not null.