Class FilesDataItemProvider

Namespace

Dynamicweb.Core.DataItemProviders

Assembly

Dynamicweb.Core.dll

Class FilesDataItemProvider.

public class FilesDataItemProvider : DataItemProvider

Inheritance

object

ConfigurableAddIn

DataItemProvider

FilesDataItemProvider

Inherited Members

DataItemProvider.DataItemType

DataItemProvider.CreateInstance(DataItemType)

DataItemProvider.LoadParametersFromDictionary(IDictionary<string, string>)

DataItemProvider.GetParametersToDictionary()

DataItemProvider.GetDataProviderTypes()

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ExcludeExtensions

Gets or sets extensions to exclude from comparison - seperate by comma. It is using a string.endswith so it does not have to be an extension only

[AddInParameter("ExcludeExtensions")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string? ExcludeExtensions { get; set; }

Property Value

string

The search pattern to use. i.e. ".exe,.pdf". Can also be used like this "translations.xml,.pdf"

ExcludeSegments

Gets or sets strings that if matched on the entire file path, will be excluded from comparison - seperate by comma. Uses Contains on the files fullname and the search strings

[AddInParameter("ExcludeSegments")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string? ExcludeSegments { get; set; }

Property Value

string

The search pattern to use. i.e. "\files\templates,\files\system".

IncludeHiddenFiles

Gets or sets a value indicating whether to include hidden files.

[AddInParameter("IncludeHiddenFiles")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool IncludeHiddenFiles { get; set; }

Property Value

bool

true if hidden files should be included; otherwise, false.

RecursiveSearch

Gets or sets a value indicating whether to perform a recursive search in sub folders.

[AddInParameter("RecursiveSearch")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool RecursiveSearch { get; set; }

Property Value

bool

true if recursive search is enabled; otherwise, false.

SearchPattern

Gets or sets the search pattern used to look for files - default is ..

[AddInParameter("SearchPattern")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string? SearchPattern { get; set; }

Property Value

string

The search pattern to use.

SkipTimestampCompare

Gets or sets a value indicating whether timestamps should be left out when comparing files.

[AddInParameter("SkipTimestampCompare")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipTimestampCompare { get; set; }

Property Value

bool

true if timestamp should be ignored in comparison; otherwise, false.

TargetPath

Gets or sets the target path.

[AddInParameter("TargetPath")]
[AddInParameterEditor(typeof(FolderSelectEditor), "")]
public string TargetPath { get; set; }

Property Value

string

The target path.

ValueKey

Gets the value key.

public string ValueKey { get; }

Property Value

string

The value key.

Methods

CreateReader()

Creates the reader.

public override DataItemReader CreateReader()

Returns

DataItemReader

CreateWriter()

Creates the writer.

public override DataItemWriter CreateWriter()

Returns

DataItemWriter

EnsureAbsoluteFilePath(string)

Ensures the absolute file path.

public string EnsureAbsoluteFilePath(string originalPath)

Parameters

originalPath string

The original path.

Returns

string

See Also

DataItemProvider