Class
FileTemplateDefinitionStorage

Represents a file-based definition storage specifically for report templates.

Definition

Namespace:Telerik.WebReportDesigner.Services

Assembly:Telerik.WebReportDesigner.Services.dll

Syntax:

cs-api-definition
public class FileTemplateDefinitionStorage : FileDefinitionStorageBase, IResourceStorage, IDefinitionStorage, IAssetsStorage

Inheritance: objectResourceStorageBaseResourceStorageFileDefinitionStorageBaseFileTemplateDefinitionStorage

Implements: IAssetsStorageIDefinitionStorageIResourceStorage

Inherited Members FileDefinitionStorageBase.GetFolderContents(string, string[])FileDefinitionStorageBase.GetByUri<TDefinitionNotFoundException>(string)FileDefinitionStorageBase.RenameAsync<TInvalidDefinitionNameException>(RenameResourceModel)FileDefinitionStorageBase.SaveAsync<TDefinitionNotFoundException>(SaveResourceModel, byte[])FileDefinitionStorageBase.GetFolderAsync(string)FileDefinitionStorageBase.GetModelAsync(string)FileDefinitionStorageBase.DeleteAsync(string)FileDefinitionStorageBase.Save(SaveResourceModel, byte[], bool, bool)FileDefinitionStorageBase.WrapException<TResult, TDefinitionException, TResourceException>(Func<TResult>)ResourceStorage.GetOrderedDefaultFoldersToCreate()ResourceStorage.GetAllByExtension(string[])ResourceStorage.GetFolderContentsAsync(string)ResourceStorage.FolderHasContents(string)ResourceStorage.GetFolderByName(string)ResourceStorage.CreateFolderAsync(CreateFolderModel)ResourceStorage.MoveFolder(MoveFolderModel)ResourceStorage.RenameFolderAsync(RenameFolderModel)ResourceStorage.DeleteFolderAsync(string)ResourceStorage.FolderNameExists(string)ResourceStorage.FolderExists(string)ResourceStorage.GetAsync(string)ResourceStorage.ResourceNameExists(string)ResourceStorage.ResourceExists(string)ResourceStorage.GetFile(string)ResourceStorage.GetModelByName(string)ResourceStorage.GetModelCore<T>(string)ResourceStorage.Save(string, byte[])ResourceStorage.SaveAsync(SaveResourceModel, byte[], bool)ResourceStorage.SaveCore<T>(SaveResourceModel, byte[], bool)ResourceStorage.Overwrite(OverwriteResourceModel, byte[])ResourceStorage.OverwriteCore<T>(OverwriteResourceModel, byte[])ResourceStorage.RenameCore<T>(RenameResourceModel)ResourceStorage.Move(MoveResourceModel)ResourceStorage.MoveCore<T>(MoveResourceModel)ResourceStorage.Search(SearchResourcesModel)ResourceStorage.CreateDirectory(string[])ResourceStorage.EnsureDefaultFolders()ResourceStorage.CreateDefaultFolder(CreateFolderModel)ResourceStorage.BaseDirResourceStorageBase.defaultFoldersResourceStorageBase.DefaultFoldersToCreateResourceStorageBase.ValidateSavedResourceExtension(string)ResourceStorageBase.IsExtensionValid(string)

Constructors

FileTemplateDefinitionStorage(string)

Initializes a new instance of the FileTemplateDefinitionStorage class.

Declaration

cs-api-definition
public FileTemplateDefinitionStorage(string baseDir)

Parameters

baseDir

string

The base directory where the template definitions are stored.

FileTemplateDefinitionStorage(string, string[])

Initializes a new instance of the FileTemplateDefinitionStorage class.

Declaration

cs-api-definition
public FileTemplateDefinitionStorage(string baseDir, string[] excludedFolders)

Parameters

baseDir

string

The base directory where the template definitions are stored.

excludedFolders

string[]

Relative folder paths to be excluded when retrieving folder contents.

Fields

RootFolderName

The constant name of the Report Templates root folder.

Declaration

cs-api-definition
public const string RootFolderName = "Report Templates"

Field Value

string

Properties

FileExtensions

Gets an array with allowed file extensions.

Declaration

cs-api-definition
protected override string[] FileExtensions { get; }

Property Value

string[]

Overrides FileDefinitionStorageBase.FileExtensions

Methods

GetByUri(string)

Finds a definition by its uri and returns its contents as byte array.

Declaration

cs-api-definition
public override byte[] GetByUri(string uri)

Parameters

uri

string

The unique resource identifier (URI) of the definition.

Returns

byte[]

Overrides ResourceStorage.GetByUri(string)

RenameAsync(RenameResourceModel)

Renames a template by its model.

Declaration

cs-api-definition
public override Task<ResourceFileModel> RenameAsync(RenameResourceModel model)

Parameters

model

RenameResourceModel

The model containing relevant data used to rename

Returns

Task<ResourceFileModel>

Overrides ResourceStorage.RenameAsync(RenameResourceModel)

Implements IAssetsStorage.RenameAsync(RenameResourceModel)

SaveAsync(SaveResourceModel, byte[])

Creates new or overwrites an existing template definition file with the provided definition bytes.

Declaration

cs-api-definition
public override Task<ResourceFileModel> SaveAsync(SaveResourceModel model, byte[] resource)

Parameters

model

SaveResourceModel

resource

byte[]

Returns

Task<ResourceFileModel>

Overrides ResourceStorage.SaveAsync(SaveResourceModel, byte[])

Implements IAssetsStorage.SaveAsync(SaveResourceModel, byte[])

ValidateDefinitionId(string)

Validates the provided definitionId.

Declaration

cs-api-definition
protected override void ValidateDefinitionId(string definitionId)

Parameters

definitionId

string

Overrides FileDefinitionStorageBase.ValidateDefinitionId(string)