Documentation

Class FileDefinitionStorageBase

Represents a base class for file-based definition storages.

Inheritance
System.Object
ResourceStorageBase
ResourceStorage
FileDefinitionStorageBase
FileDefinitionStorage
FileSharedDataSourceStorage
Inherited Members
Namespace: Telerik.WebReportDesigner.Services
Assembly: Telerik.WebReportDesigner.Services.dll

Syntax

public abstract class FileDefinitionStorageBase : ResourceStorage, IResourceStorage, IAssetsStorage, IHasBaseDir

Constructors

FileDefinitionStorageBase(String, String[])

Creates an instance of FileDefinitionStorageBase class.

Declaration
public FileDefinitionStorageBase(string baseDir, string[] definitionFolders)
Parameters
System.String baseDir

System.String[] definitionFolders

FileDefinitionStorageBase(String, String[], String[])

Creates an instance of FileDefinitionStorageBase class.

Declaration
public FileDefinitionStorageBase(string baseDir, string[] definitionFolders, string[] excludedFolders)
Parameters
System.String baseDir

System.String[] definitionFolders

System.String[] excludedFolders

Properties

FileExtensions

Gets an array with allowed file extensions.

Declaration
protected abstract string[] FileExtensions { get; }
Property Value
System.String[]

Methods

DeleteAsync(String)

Deletes a report by its uri.

Declaration
public override Task DeleteAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI) of the report.
Returns
System.Threading.Tasks.Task

Overrides

GetByUri<TDefinitionNotFoundException>(String)

Returns the raw bytes from the given uri.

Declaration
protected virtual byte[] GetByUri<TDefinitionNotFoundException>(string uri)
    where TDefinitionNotFoundException : Exception
Parameters
System.String uri

Returns
System.Byte[]

Type Parameters
TDefinitionNotFoundException

GetFolderAsync(String)

Returns the folder model at uri or null if not found.

Declaration
public override Task<ResourceFolderModel> GetFolderAsync(string uri)
Parameters
System.String uri

Returns
System.Threading.Tasks.Task<ResourceFolderModel>

Overrides

GetFolderContents(String, String[])

Lists all definition resource files found in the given uri.

Declaration
public override IEnumerable<ResourceModelBase> GetFolderContents(string uri, string[] searchPattern)
Parameters
System.String uri

The unique resource identifier(URI) of the folder. null or empty string represents the root directory
System.String[] searchPattern

The file search patterns used when retrieving definition resources.
Returns
System.Collections.Generic.IEnumerable<ResourceModelBase>

A list of all files and subfolders found in the provided folder URI as an enumerable of ResourceModelBase
Overrides

GetModelAsync(String)

Returns the resource model at uri or null if not found.

Declaration
public override Task<ResourceFileModel> GetModelAsync(string uri)
Parameters
System.String uri

Returns
System.Threading.Tasks.Task<ResourceFileModel>

Overrides

RenameAsync<TInvalidDefinitionNameException>(RenameResourceModel)

Renames a definition asset.

Declaration
protected virtual Task<ResourceFileModel> RenameAsync<TInvalidDefinitionNameException>(RenameResourceModel model)
    where TInvalidDefinitionNameException : Exception
Parameters
RenameResourceModel model

Returns
System.Threading.Tasks.Task<ResourceFileModel>

Type Parameters
TInvalidDefinitionNameException

Save(SaveResourceModel, Byte[], Boolean, Boolean)

Creates new or overwrites an existing Report- or SharedDataSource definition file with the provided definition bytes.

Declaration
public ResourceFileModel Save(SaveResourceModel model, byte[] resource, bool overwrite, bool forcePath)
Parameters
SaveResourceModel model

System.Byte[] resource

System.Boolean overwrite

System.Boolean forcePath

Returns
ResourceFileModel

SaveAsync<TDefinitionNotFoundException>(SaveResourceModel, Byte[])

Saves a definition asset.

Declaration
protected virtual Task<ResourceFileModel> SaveAsync<TDefinitionNotFoundException>(SaveResourceModel model, byte[] resource)
    where TDefinitionNotFoundException : Exception
Parameters
SaveResourceModel model

System.Byte[] resource

Returns
System.Threading.Tasks.Task<ResourceFileModel>

Type Parameters
TDefinitionNotFoundException

ValidateDefinitionId(String)

Validates the provided definitionId.

Declaration
protected abstract void ValidateDefinitionId(string definitionId)
Parameters
System.String definitionId

WrapException<TResult, TDefinitionException, TResourceException>(Func<TResult>)

Executes a callback and wraps the TResourceException in a TDefinitionException, if one occurs.

Declaration
protected TResult WrapException<TResult, TDefinitionException, TResourceException>(Func<TResult> callback)
    where TDefinitionException : Exception where TResourceException : Exception
Parameters
System.Func<TResult> callback

Returns
TResult

Type Parameters
TResult

TDefinitionException

TResourceException