Class FileInfo

Represents the File object and holds the Properties of that object.

Inheritance

System.Object

BaseEntityInfo

FileInfo

Implements

IHydratable

IFileInfo

Inherited Members

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

BaseEntityInfo.CreatedByUser(Int32)

BaseEntityInfo.LastModifiedByUser(Int32)

BaseEntityInfo.FillInternal(IDataReader)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

Namespace: DotNetNuke.Services.FileSystem

Assembly: DotNetNuke.dll

Syntax

public class FileInfo : BaseEntityInfo, IHydratable, IFileInfo

Constructors

| Improve this Doc View Source

FileInfo()

Initializes a new instance of the FileInfo class.

Declaration

public FileInfo()

| Improve this Doc View Source

FileInfo(Guid, Guid, Int32, String, String, Int32, Int32, Int32, String, String, Int32, Int32, Boolean, String)

Initializes a new instance of the FileInfo class.

Declaration

public FileInfo(Guid uniqueId, Guid versionGuid, int portalId, string filename, string extension, int filesize, int width, int height, string contentType, string folder, int folderId, int storageLocation, bool cached, string hash)

Parameters

Type	Name	Description
Guid	uniqueId
Guid	versionGuid
System.Int32	portalId
System.String	filename
System.String	extension
System.Int32	filesize
System.Int32	width
System.Int32	height
System.String	contentType
System.String	folder
System.Int32	folderId
System.Int32	storageLocation
System.Boolean	cached
System.String	hash

| Improve this Doc View Source

FileInfo(Int32, String, String, Int32, Int32, Int32, String, String, Int32, Int32, Boolean, String)

Initializes a new instance of the FileInfo class.

Declaration

public FileInfo(int portalId, string filename, string extension, int filesize, int width, int height, string contentType, string folder, int folderId, int storageLocation, bool cached, string hash)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	filename
System.String	extension
System.Int32	filesize
System.Int32	width
System.Int32	height
System.String	contentType
System.String	folder
System.Int32	folderId
System.Int32	storageLocation
System.Boolean	cached
System.String	hash

| Improve this Doc View Source

FileInfo(Int32, String, String, Int32, Int32, Int32, String, String, Int32, Int32, Boolean)

Initializes a new instance of the FileInfo class.

Declaration

public FileInfo(int portalId, string filename, string extension, int filesize, int width, int height, string contentType, string folder, int folderId, int storageLocation, bool cached)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	filename
System.String	extension
System.Int32	filesize
System.Int32	width
System.Int32	height
System.String	contentType
System.String	folder
System.Int32	folderId
System.Int32	storageLocation
System.Boolean	cached

Properties

| Improve this Doc View Source

ContentItemID

Gets or sets a reference to ContentItem, to use in Workflows.

Declaration

public int ContentItemID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ContentType

Represents the File object and holds the Properties of that object.

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Description

Represents the File object and holds the Properties of that object.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

EnablePublishPeriod

Gets or sets a value indicating whether publish period is enabled for the file.

Declaration

public bool EnablePublishPeriod { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

EndDate

Gets or sets the date on which the file ends to be published.

Declaration

public DateTime EndDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

Extension

Represents the File object and holds the Properties of that object.

Declaration

public string Extension { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

FileAttributes

Represents the File object and holds the Properties of that object.

Declaration

public FileAttributes? FileAttributes { get; }

Property Value

Type	Description
System.Nullable<FileAttributes>

| Improve this Doc View Source

FileId

Represents the File object and holds the Properties of that object.

Declaration

public int FileId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

FileName

Represents the File object and holds the Properties of that object.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Folder

Represents the File object and holds the Properties of that object.

Declaration

public string Folder { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

FolderId

Represents the File object and holds the Properties of that object.

Declaration

public int FolderId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

FolderMappingID

Represents the File object and holds the Properties of that object.

Declaration

public int FolderMappingID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

HasBeenPublished

Gets a value indicating whether gets a flag which says whether the file has ever been published.

Declaration

public bool HasBeenPublished { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Height

Represents the File object and holds the Properties of that object.

Declaration

public int Height { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

IsCached

Represents the File object and holds the Properties of that object.

Declaration

public bool IsCached { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsEnabled

Gets a value indicating whether the file is enabled, considering if the publish period is active and if the current date is within the publish period.

Declaration

public bool IsEnabled { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeyID

Represents the File object and holds the Properties of that object.

Declaration

public int KeyID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

LastModificationTime

Represents the File object and holds the Properties of that object.

Declaration

public DateTime LastModificationTime { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

PhysicalPath

Represents the File object and holds the Properties of that object.

Declaration

public string PhysicalPath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PortalId

Represents the File object and holds the Properties of that object.

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PublishedVersion

Gets or sets the published version number of the file.

Declaration

public int PublishedVersion { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

RelativePath

Represents the File object and holds the Properties of that object.

Declaration

public string RelativePath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SHA1Hash

Represents the File object and holds the Properties of that object.

Declaration

public string SHA1Hash { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Size

Represents the File object and holds the Properties of that object.

Declaration

public int Size { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

StartDate

Gets or sets the date on which the file starts to be published.

Declaration

public DateTime StartDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

StorageLocation

Represents the File object and holds the Properties of that object.

Declaration

public int StorageLocation { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SupportsFileAttributes

Represents the File object and holds the Properties of that object.

Declaration

public bool SupportsFileAttributes { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Title

Gets or sets a metadata field with an optional title associated to the file.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UniqueId

Represents the File object and holds the Properties of that object.

Declaration

public Guid UniqueId { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

VersionGuid

Represents the File object and holds the Properties of that object.

Declaration

public Guid VersionGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

Width

Represents the File object and holds the Properties of that object.

Declaration

public int Width { get; set; }

Property Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

Fill(IDataReader)

Represents the File object and holds the Properties of that object.

Declaration

public void Fill(IDataReader dr)

Parameters

Type	Name	Description
IDataReader	dr

Implements

IHydratable

IFileInfo

Extension Methods

JsonExtensionsWeb.ToJson(Object)