Search Results for

    Show / Hide Table of Contents

    Class RenderMudSwitchAttribute

    This class is an attribute that, when applied to a bool property, causes the form generator to render the property as a MudBlazor.MudSwitch`1 component.

    Inheritance
    System.Object
    System.Attribute
    CG.Blazor.Forms.Attributes.FormGeneratorAttribute
    RenderMudSwitchAttribute
    Inherited Members
    System.Attribute.Equals(System.Object)
    System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
    System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
    System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
    System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
    System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
    System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
    System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
    System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
    System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
    System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
    System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
    System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.Module)
    System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
    System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
    System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
    System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
    System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
    System.Attribute.GetHashCode()
    System.Attribute.IsDefaultAttribute()
    System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
    System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
    System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
    System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
    System.Attribute.IsDefined(System.Reflection.Module, System.Type)
    System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
    System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
    System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
    System.Attribute.Match(System.Object)
    System.Attribute.TypeId
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: CG.Blazor.Forms.Attributes
    Assembly: CG.Blazor.Forms._MudBlazor.dll
    Syntax
    [AttributeUsage(AttributeTargets.Property)]
    public class RenderMudSwitchAttribute : FormGeneratorAttribute
    Remarks

    This attribute is only valid when placed on a property of type: bool.

    Examples

    Here is an example of decorating a model property to render a MudBlazor.MudSwitch`1:

    using CG.Blazor.Forms.Attributes;
    class MyModel
    {
        [RenderMudSwitch]
        public bool MyProperty { get;set; }
    }

    Constructors

    RenderMudSwitchAttribute()

    This constructor creates a new instance of the RenderMudSwitchAttribute class.

    Declaration
    public RenderMudSwitchAttribute()

    Properties

    Color

    This property indicates what color to use for the switch.

    Declaration
    public Color Color { get; set; }
    Property Value
    Type Description
    MudBlazor.Color

    Disabled

    This property indicates whether the switch is disabled, or not.

    Declaration
    public bool Disabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    DisableRipple

    This property indicates whether to disable the ripple, or not.

    Declaration
    public bool DisableRipple { get; set; }
    Property Value
    Type Description
    System.Boolean

    Label

    This property contains the label for the switch.

    Declaration
    public string Label { get; set; }
    Property Value
    Type Description
    System.String

    ReadOnly

    This property indicates whether the switch is read only, or not.

    Declaration
    public bool ReadOnly { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Generate(RenderTreeBuilder, Int32, IHandleEvent, Stack<Object>, PropertyInfo, ILogger<IFormGenerator>)

    Declaration
    public override int Generate(RenderTreeBuilder builder, int index, IHandleEvent eventTarget, Stack<object> path, PropertyInfo prop, ILogger<IFormGenerator> logger)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder builder
    System.Int32 index
    Microsoft.AspNetCore.Components.IHandleEvent eventTarget
    System.Collections.Generic.Stack<System.Object> path
    System.Reflection.PropertyInfo prop
    Microsoft.Extensions.Logging.ILogger<CG.Blazor.Forms.Services.IFormGenerator> logger
    Returns
    Type Description
    System.Int32
    Overrides
    CG.Blazor.Forms.Attributes.FormGeneratorAttribute.Generate(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder, System.Int32, Microsoft.AspNetCore.Components.IHandleEvent, System.Collections.Generic.Stack<System.Object>, System.Reflection.PropertyInfo, Microsoft.Extensions.Logging.ILogger<CG.Blazor.Forms.Services.IFormGenerator>)

    ToAttributes()

    Declaration
    public override IDictionary<string, object> ToAttributes()
    Returns
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>
    Overrides
    CG.Blazor.Forms.Attributes.FormGeneratorAttribute.ToAttributes()
    In This Article
    Back to top Generated by DocFX