CKFinder 3 – ASP.NET Connector Documentation
ResourceTypeBuilder Class Reference

Builds an instance of ResourceType using fluent interface. More...

Public Member Functions

 ResourceTypeBuilder (string name)
 Constructs a new instance of ResourceTypeBuilder. More...
 
ResourceTypeBuilder SetAllowedExtensions (params string[] extensions)
 Adds allowed extensions to the ResourceType. More...
 
ResourceTypeBuilder SetDeniedExtensions (params string[] extensions)
 Adds denied extensions to the ResourceType. More...
 
ResourceTypeBuilder SetMaxFileSize (long maxSize)
 Definies maximum file size for this ResourceType. More...
 
ResourceTypeBuilder SetLabel (string label)
 Defines label for the ResourceType. More...
 
ResourceTypeBuilder SetLazyLoaded (bool enable)
 Defines that the ResourceType is lazy loaded. More...
 
ResourceTypeBuilder SetBackend (string backendName, string root)
 Defines backend for the ResourceType. More...
 
ResourceTypeBuilder SetAllowedHtmlExtensionMatchers (params StringMatcher[] matchers)
 Sets extension matchers for which files may contain HTML code. More...
 
ResourceTypeBuilder SetHideFilesMatchers (params StringMatcher[] matchers)
 Sets matchers of file names for which files will be hidden in the backend. More...
 
ResourceTypeBuilder SetHideFoldersMatchers (params StringMatcher[] matchers)
 Sets matchers of folder names for which folders will be hidden in the backend. More...
 
ResourceType Build (IThumbnailSettings thumbnailSettings, IBackendRepository backendRepository, IImageMetadataCacheRepository imageMetadataCacheRepository)
 Builds instance of the ResourceType. More...
 

Detailed Description

Builds an instance of ResourceType using fluent interface.

Constructor & Destructor Documentation

◆ ResourceTypeBuilder()

ResourceTypeBuilder ( string  name)
inline

Constructs a new instance of ResourceTypeBuilder.

Parameters
nameA name of the ResourceType. Each ResourceType in a connector must have unique name.

Member Function Documentation

◆ Build()

ResourceType Build ( IThumbnailSettings  thumbnailSettings,
IBackendRepository  backendRepository,
IImageMetadataCacheRepository  imageMetadataCacheRepository 
)
inline

Builds instance of the ResourceType.

Parameters
thumbnailSettingsAn instance of thumbnail settings.
backendRepositoryAn instance of backend repository.
imageMetadataCacheRepositoryAn instance of image metadata cache repository.
Returns
Instance of ResourceType.

◆ SetAllowedExtensions()

ResourceTypeBuilder SetAllowedExtensions ( params string[]  extensions)
inline

Adds allowed extensions to the ResourceType.

Allowed and denied extensions cannot be mixed. If at least one allowed extension is provided, this method will clear all denied extensions.

Parameters
extensionsAn array or list of allowed extensions.
Returns
Current instance of ResourceTypeBuilder.

◆ SetAllowedHtmlExtensionMatchers()

ResourceTypeBuilder SetAllowedHtmlExtensionMatchers ( params StringMatcher[]  matchers)
inline

Sets extension matchers for which files may contain HTML code.

Parameters
matchersAn array or list of matchers.
Returns
Current instance of ResourceTypeBuilder.

◆ SetBackend()

ResourceTypeBuilder SetBackend ( string  backendName,
string  root 
)
inline

Defines backend for the ResourceType.

Parameters
backendNameA name of the backend.
rootA base path in the backend.
Returns
Current instance of ResourceTypeBuilder.

◆ SetDeniedExtensions()

ResourceTypeBuilder SetDeniedExtensions ( params string[]  extensions)
inline

Adds denied extensions to the ResourceType.

Allowed and denied extensions cannot be mixed. If at least one denied extension is provided, this method will clear all allowed extensions.

Parameters
extensionsAn array or list of denied extensions.
Returns
Current instance of ResourceTypeBuilder.

◆ SetHideFilesMatchers()

ResourceTypeBuilder SetHideFilesMatchers ( params StringMatcher[]  matchers)
inline

Sets matchers of file names for which files will be hidden in the backend.

Parameters
matchersAn array or list of matchers.
Returns
Current instance of ResourceTypeBuilder.

◆ SetHideFoldersMatchers()

ResourceTypeBuilder SetHideFoldersMatchers ( params StringMatcher[]  matchers)
inline

Sets matchers of folder names for which folders will be hidden in the backend.

Parameters
matchersAn array or list of matchers.
Returns
Current instance of ResourceTypeBuilder.

◆ SetLabel()

ResourceTypeBuilder SetLabel ( string  label)
inline

Defines label for the ResourceType.

If label is defined it will be used in a client application.

Parameters
labelA label text.
Returns
Current instance of ResourceTypeBuilder.

◆ SetLazyLoaded()

ResourceTypeBuilder SetLazyLoaded ( bool  enable)
inline

Defines that the ResourceType is lazy loaded.

Parameters
enableA boolean whether to enable this option.
Returns
Current instance of ResourceTypeBuilder.

◆ SetMaxFileSize()

ResourceTypeBuilder SetMaxFileSize ( long  maxSize)
inline

Definies maximum file size for this ResourceType.

Parameters
maxSizeA maximum file size in bytes.
Returns
Current instance of ResourceTypeBuilder.

The documentation for this class was generated from the following file: