Class FilePathSettingDescriptor

Descriptor for a file path setting. Rendered as a text box with a "Browse..." button.

Inheritance

object

SettingDescriptor

FilePathSettingDescriptor

Inherited Members

SettingDescriptor.Key

SettingDescriptor.DisplayName

SettingDescriptor.Description

SettingDescriptor.IconSvg

SettingDescriptor.IsVisible

SettingDescriptor.IsRequired

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Zaya.Primitives

Assembly: Zaya.Primitives.dll

Syntax

public sealed class FilePathSettingDescriptor : SettingDescriptor

Constructors

FilePathSettingDescriptor(string, LocalizedString)

Initializes a new instance of the FilePathSettingDescriptor class.

Declaration

public FilePathSettingDescriptor(string key, LocalizedString displayName)

Parameters

Type	Name	Description
string	key	Machine-readable key for this setting.
LocalizedString	displayName	Localizable UI label.

Properties

DefaultValue

Gets or sets the default file path.

Declaration

public string? DefaultValue { get; init; }

Property Value

Type	Description
string

FileFilter

Gets or sets an optional file filter for the open-file dialog (e.g. ".dll|.exe").

Declaration

public string? FileFilter { get; init; }

Property Value

Type	Description
string

FileMustExist

Gets or sets whether the file must already exist on disk before validation passes.

Declaration

public bool FileMustExist { get; init; }

Property Value

Type	Description
bool