docs/api/Zaya.Primitives.StringSettingDescriptor.yml - main - veer/Zaya.Primitives

docs/api/Zaya.Primitives.StringSettingDescriptor.yml
606 строк21 KB
Vladimir Makarov
docs
29 июл 2026, 13:13
29 июл 2026, 13:1350b4c9c
### YamlMime:ManagedReference
items:
- uid: Zaya.Primitives.StringSettingDescriptor
  commentId: T:Zaya.Primitives.StringSettingDescriptor
  id: StringSettingDescriptor
  parent: Zaya.Primitives
  children:
  - Zaya.Primitives.StringSettingDescriptor.#ctor(System.String,Zaya.Primitives.LocalizedString)
  - Zaya.Primitives.StringSettingDescriptor.DefaultValue
  - Zaya.Primitives.StringSettingDescriptor.MaxLength
  - Zaya.Primitives.StringSettingDescriptor.MinLength
  - Zaya.Primitives.StringSettingDescriptor.RegexPattern
  langs:
  - csharp
  - vb
  name: StringSettingDescriptor
  nameWithType: StringSettingDescriptor
  fullName: Zaya.Primitives.StringSettingDescriptor
  type: Class
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: StringSettingDescriptor
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 76
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Descriptor for a free-text string setting. Supports min/max length and optional regex validation.
  example: []
  syntax:
    content: 'public sealed class StringSettingDescriptor : SettingDescriptor'
    content.vb: Public NotInheritable Class StringSettingDescriptor Inherits SettingDescriptor
  inheritance:
  - System.Object
  - Zaya.Primitives.SettingDescriptor
  inheritedMembers:
  - Zaya.Primitives.SettingDescriptor.Key
  - Zaya.Primitives.SettingDescriptor.DisplayName
  - Zaya.Primitives.SettingDescriptor.Description
  - Zaya.Primitives.SettingDescriptor.IconSvg
  - Zaya.Primitives.SettingDescriptor.IsVisible
  - Zaya.Primitives.SettingDescriptor.IsRequired
  - System.Object.Equals(System.Object)
  - System.Object.Equals(System.Object,System.Object)
  - System.Object.GetHashCode
  - System.Object.GetType
  - System.Object.ReferenceEquals(System.Object,System.Object)
  - System.Object.ToString
- uid: Zaya.Primitives.StringSettingDescriptor.DefaultValue
  commentId: P:Zaya.Primitives.StringSettingDescriptor.DefaultValue
  id: DefaultValue
  parent: Zaya.Primitives.StringSettingDescriptor
  langs:
  - csharp
  - vb
  name: DefaultValue
  nameWithType: StringSettingDescriptor.DefaultValue
  fullName: Zaya.Primitives.StringSettingDescriptor.DefaultValue
  type: Property
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: DefaultValue
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 81
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Gets or sets the default text value.
  example: []
  syntax:
    content: public string? DefaultValue { get; init; }
    parameters: []
    return:
      type: System.String
    content.vb: Public Property DefaultValue As String
  overload: Zaya.Primitives.StringSettingDescriptor.DefaultValue*
- uid: Zaya.Primitives.StringSettingDescriptor.MinLength
  commentId: P:Zaya.Primitives.StringSettingDescriptor.MinLength
  id: MinLength
  parent: Zaya.Primitives.StringSettingDescriptor
  langs:
  - csharp
  - vb
  name: MinLength
  nameWithType: StringSettingDescriptor.MinLength
  fullName: Zaya.Primitives.StringSettingDescriptor.MinLength
  type: Property
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: MinLength
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 86
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Gets or sets the minimum allowed string length (inclusive).
  example: []
  syntax:
    content: public int? MinLength { get; init; }
    parameters: []
    return:
      type: System.Nullable{System.Int32}
    content.vb: Public Property MinLength As Integer?
  overload: Zaya.Primitives.StringSettingDescriptor.MinLength*
- uid: Zaya.Primitives.StringSettingDescriptor.MaxLength
  commentId: P:Zaya.Primitives.StringSettingDescriptor.MaxLength
  id: MaxLength
  parent: Zaya.Primitives.StringSettingDescriptor
  langs:
  - csharp
  - vb
  name: MaxLength
  nameWithType: StringSettingDescriptor.MaxLength
  fullName: Zaya.Primitives.StringSettingDescriptor.MaxLength
  type: Property
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: MaxLength
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 91
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Gets or sets the maximum allowed string length (inclusive).
  example: []
  syntax:
    content: public int? MaxLength { get; init; }
    parameters: []
    return:
      type: System.Nullable{System.Int32}
    content.vb: Public Property MaxLength As Integer?
  overload: Zaya.Primitives.StringSettingDescriptor.MaxLength*
- uid: Zaya.Primitives.StringSettingDescriptor.RegexPattern
  commentId: P:Zaya.Primitives.StringSettingDescriptor.RegexPattern
  id: RegexPattern
  parent: Zaya.Primitives.StringSettingDescriptor
  langs:
  - csharp
  - vb
  name: RegexPattern
  nameWithType: StringSettingDescriptor.RegexPattern
  fullName: Zaya.Primitives.StringSettingDescriptor.RegexPattern
  type: Property
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: RegexPattern
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 96
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Gets or sets an optional regex pattern for validation.
  example: []
  syntax:
    content: public string? RegexPattern { get; init; }
    parameters: []
    return:
      type: System.String
    content.vb: Public Property RegexPattern As String
  overload: Zaya.Primitives.StringSettingDescriptor.RegexPattern*
- uid: Zaya.Primitives.StringSettingDescriptor.#ctor(System.String,Zaya.Primitives.LocalizedString)
  commentId: M:Zaya.Primitives.StringSettingDescriptor.#ctor(System.String,Zaya.Primitives.LocalizedString)
  id: '#ctor(System.String,Zaya.Primitives.LocalizedString)'
  parent: Zaya.Primitives.StringSettingDescriptor
  langs:
  - csharp
  - vb
  name: StringSettingDescriptor(string, LocalizedString)
  nameWithType: StringSettingDescriptor.StringSettingDescriptor(string, LocalizedString)
  fullName: Zaya.Primitives.StringSettingDescriptor.StringSettingDescriptor(string, Zaya.Primitives.LocalizedString)
  type: Constructor
  source:
    remote:
      path: src/Zaya.Primitives/SettingDescriptor.cs
      branch: main
      repo: https://github.com/shtrasser-dev/Zaya.Primitives
    id: .ctor
    path: src/Zaya.Primitives/SettingDescriptor.cs
    startLine: 103
  assemblies:
  - Zaya.Primitives
  namespace: Zaya.Primitives
  summary: Initializes a new instance of the <xref href="Zaya.Primitives.StringSettingDescriptor" data-throw-if-not-resolved="false"></xref> class.
  example: []
  syntax:
    content: public StringSettingDescriptor(string key, LocalizedString displayName)
    parameters:
    - id: key
      type: System.String
      description: Machine-readable key for this setting.
    - id: displayName
      type: Zaya.Primitives.LocalizedString
      description: Localizable UI label.
    content.vb: Public Sub New(key As String, displayName As LocalizedString)
  overload: Zaya.Primitives.StringSettingDescriptor.#ctor*
  nameWithType.vb: StringSettingDescriptor.New(String, LocalizedString)
  fullName.vb: Zaya.Primitives.StringSettingDescriptor.New(String, Zaya.Primitives.LocalizedString)
  name.vb: New(String, LocalizedString)
references:
- uid: Zaya.Primitives
  commentId: N:Zaya.Primitives
  href: Zaya.html
  name: Zaya.Primitives
  nameWithType: Zaya.Primitives
  fullName: Zaya.Primitives
  spec.csharp:
  - uid: Zaya
    name: Zaya
    href: Zaya.html
  - name: .
  - uid: Zaya.Primitives
    name: Primitives
    href: Zaya.Primitives.html
  spec.vb:
  - uid: Zaya
    name: Zaya
    href: Zaya.html
  - name: .
  - uid: Zaya.Primitives
    name: Primitives
    href: Zaya.Primitives.html
- uid: System.Object
  commentId: T:System.Object
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object
  name: object
  nameWithType: object
  fullName: object
  nameWithType.vb: Object
  fullName.vb: Object
  name.vb: Object
- uid: Zaya.Primitives.SettingDescriptor
  commentId: T:Zaya.Primitives.SettingDescriptor
  parent: Zaya.Primitives
  href: Zaya.Primitives.SettingDescriptor.html
  name: SettingDescriptor
  nameWithType: SettingDescriptor
  fullName: Zaya.Primitives.SettingDescriptor
- uid: Zaya.Primitives.SettingDescriptor.Key
  commentId: P:Zaya.Primitives.SettingDescriptor.Key
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_Key
  name: Key
  nameWithType: SettingDescriptor.Key
  fullName: Zaya.Primitives.SettingDescriptor.Key
- uid: Zaya.Primitives.SettingDescriptor.DisplayName
  commentId: P:Zaya.Primitives.SettingDescriptor.DisplayName
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_DisplayName
  name: DisplayName
  nameWithType: SettingDescriptor.DisplayName
  fullName: Zaya.Primitives.SettingDescriptor.DisplayName
- uid: Zaya.Primitives.SettingDescriptor.Description
  commentId: P:Zaya.Primitives.SettingDescriptor.Description
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_Description
  name: Description
  nameWithType: SettingDescriptor.Description
  fullName: Zaya.Primitives.SettingDescriptor.Description
- uid: Zaya.Primitives.SettingDescriptor.IconSvg
  commentId: P:Zaya.Primitives.SettingDescriptor.IconSvg
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_IconSvg
  name: IconSvg
  nameWithType: SettingDescriptor.IconSvg
  fullName: Zaya.Primitives.SettingDescriptor.IconSvg
- uid: Zaya.Primitives.SettingDescriptor.IsVisible
  commentId: P:Zaya.Primitives.SettingDescriptor.IsVisible
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_IsVisible
  name: IsVisible
  nameWithType: SettingDescriptor.IsVisible
  fullName: Zaya.Primitives.SettingDescriptor.IsVisible
- uid: Zaya.Primitives.SettingDescriptor.IsRequired
  commentId: P:Zaya.Primitives.SettingDescriptor.IsRequired
  parent: Zaya.Primitives.SettingDescriptor
  href: Zaya.Primitives.SettingDescriptor.html#Zaya_Primitives_SettingDescriptor_IsRequired
  name: IsRequired
  nameWithType: SettingDescriptor.IsRequired
  fullName: Zaya.Primitives.SettingDescriptor.IsRequired
- uid: System.Object.Equals(System.Object)
  commentId: M:System.Object.Equals(System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  name: Equals(object)
  nameWithType: object.Equals(object)
  fullName: object.Equals(object)
  nameWithType.vb: Object.Equals(Object)
  fullName.vb: Object.Equals(Object)
  name.vb: Equals(Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.Equals(System.Object,System.Object)
  commentId: M:System.Object.Equals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  name: Equals(object, object)
  nameWithType: object.Equals(object, object)
  fullName: object.Equals(object, object)
  nameWithType.vb: Object.Equals(Object, Object)
  fullName.vb: Object.Equals(Object, Object)
  name.vb: Equals(Object, Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.GetHashCode
  commentId: M:System.Object.GetHashCode
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  name: GetHashCode()
  nameWithType: object.GetHashCode()
  fullName: object.GetHashCode()
  nameWithType.vb: Object.GetHashCode()
  fullName.vb: Object.GetHashCode()
  spec.csharp:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  - name: (
  - name: )
- uid: System.Object.GetType
  commentId: M:System.Object.GetType
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  name: GetType()
  nameWithType: object.GetType()
  fullName: object.GetType()
  nameWithType.vb: Object.GetType()
  fullName.vb: Object.GetType()
  spec.csharp:
  - uid: System.Object.GetType
    name: GetType
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.GetType
    name: GetType
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  - name: (
  - name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
  commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  name: ReferenceEquals(object, object)
  nameWithType: object.ReferenceEquals(object, object)
  fullName: object.ReferenceEquals(object, object)
  nameWithType.vb: Object.ReferenceEquals(Object, Object)
  fullName.vb: Object.ReferenceEquals(Object, Object)
  name.vb: ReferenceEquals(Object, Object)
  spec.csharp:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.ToString
  commentId: M:System.Object.ToString
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  name: ToString()
  nameWithType: object.ToString()
  fullName: object.ToString()
  nameWithType.vb: Object.ToString()
  fullName.vb: Object.ToString()
  spec.csharp:
  - uid: System.Object.ToString
    name: ToString
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.ToString
    name: ToString
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  - name: (
  - name: )
- uid: System
  commentId: N:System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system
  name: System
  nameWithType: System
  fullName: System
- uid: Zaya.Primitives.StringSettingDescriptor.DefaultValue*
  commentId: Overload:Zaya.Primitives.StringSettingDescriptor.DefaultValue
  href: Zaya.Primitives.StringSettingDescriptor.html#Zaya_Primitives_StringSettingDescriptor_DefaultValue
  name: DefaultValue
  nameWithType: StringSettingDescriptor.DefaultValue
  fullName: Zaya.Primitives.StringSettingDescriptor.DefaultValue
- uid: System.String
  commentId: T:System.String
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.string
  name: string
  nameWithType: string
  fullName: string
  nameWithType.vb: String
  fullName.vb: String
  name.vb: String
- uid: Zaya.Primitives.StringSettingDescriptor.MinLength*
  commentId: Overload:Zaya.Primitives.StringSettingDescriptor.MinLength
  href: Zaya.Primitives.StringSettingDescriptor.html#Zaya_Primitives_StringSettingDescriptor_MinLength
  name: MinLength
  nameWithType: StringSettingDescriptor.MinLength
  fullName: Zaya.Primitives.StringSettingDescriptor.MinLength
- uid: System.Nullable{System.Int32}
  commentId: T:System.Nullable{System.Int32}
  parent: System
  definition: System.Nullable`1
  href: https://learn.microsoft.com/dotnet/api/system.int32
  name: int?
  nameWithType: int?
  fullName: int?
  nameWithType.vb: Integer?
  fullName.vb: Integer?
  name.vb: Integer?
  spec.csharp:
  - uid: System.Int32
    name: int
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.int32
  - name: '?'
  spec.vb:
  - uid: System.Int32
    name: Integer
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.int32
  - name: '?'
- uid: System.Nullable`1
  commentId: T:System.Nullable`1
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.nullable-1
  name: Nullable<T>
  nameWithType: Nullable<T>
  fullName: System.Nullable<T>
  nameWithType.vb: Nullable(Of T)
  fullName.vb: System.Nullable(Of T)
  name.vb: Nullable(Of T)
  spec.csharp:
  - uid: System.Nullable`1
    name: Nullable
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.nullable-1
  - name: <
  - name: T
  - name: '>'
  spec.vb:
  - uid: System.Nullable`1
    name: Nullable
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.nullable-1
  - name: (
  - name: Of
  - name: " "
  - name: T
  - name: )
- uid: Zaya.Primitives.StringSettingDescriptor.MaxLength*
  commentId: Overload:Zaya.Primitives.StringSettingDescriptor.MaxLength
  href: Zaya.Primitives.StringSettingDescriptor.html#Zaya_Primitives_StringSettingDescriptor_MaxLength
  name: MaxLength
  nameWithType: StringSettingDescriptor.MaxLength
  fullName: Zaya.Primitives.StringSettingDescriptor.MaxLength
- uid: Zaya.Primitives.StringSettingDescriptor.RegexPattern*
  commentId: Overload:Zaya.Primitives.StringSettingDescriptor.RegexPattern
  href: Zaya.Primitives.StringSettingDescriptor.html#Zaya_Primitives_StringSettingDescriptor_RegexPattern
  name: RegexPattern
  nameWithType: StringSettingDescriptor.RegexPattern
  fullName: Zaya.Primitives.StringSettingDescriptor.RegexPattern
- uid: Zaya.Primitives.StringSettingDescriptor
  commentId: T:Zaya.Primitives.StringSettingDescriptor
  href: Zaya.Primitives.StringSettingDescriptor.html
  name: StringSettingDescriptor
  nameWithType: StringSettingDescriptor
  fullName: Zaya.Primitives.StringSettingDescriptor
- uid: Zaya.Primitives.StringSettingDescriptor.#ctor*
  commentId: Overload:Zaya.Primitives.StringSettingDescriptor.#ctor
  href: Zaya.Primitives.StringSettingDescriptor.html#Zaya_Primitives_StringSettingDescriptor__ctor_System_String_Zaya_Primitives_LocalizedString_
  name: StringSettingDescriptor
  nameWithType: StringSettingDescriptor.StringSettingDescriptor
  fullName: Zaya.Primitives.StringSettingDescriptor.StringSettingDescriptor
  nameWithType.vb: StringSettingDescriptor.New
  fullName.vb: Zaya.Primitives.StringSettingDescriptor.New
  name.vb: New
- uid: Zaya.Primitives.LocalizedString
  commentId: T:Zaya.Primitives.LocalizedString
  parent: Zaya.Primitives
  href: Zaya.Primitives.LocalizedString.html
  name: LocalizedString
  nameWithType: LocalizedString
  fullName: Zaya.Primitives.LocalizedString