CodeBeam.MudBlazor.Extensions/docs/CodeBeam.MudBlazor.Extensions.Docs.Wasm/wwwroot/CodeBeam.MudBlazor.Extensions.Code.xml at 8301e7243a671d9200758088cc88306201a4e249 · mckaragoz/CodeBeam.MudBlazor.Extensions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>CodeBeam.MudBlazor.Extensions.Code</name>
    </assembly>
    <members>
        <member name="T:MudExtensions.MudCodeViewer">
            <summary>
            Represents a component that displays formatted code snippets with syntax highlighting.
            </summary>
            <remarks>Use this component to present code examples or source code within a user interface, typically
            for documentation or demonstration purposes. The component supports syntax highlighting to improve readability.
            </remarks>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.#ctor">
            <summary>
            Initializes a new instance of the MudCodeViewer class.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.Classname">
            <summary>
            Gets the CSS class string for the code viewer component, including any additional classes specified by the user.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.HeaderClassname">
            <summary>
            Gets the CSS class string applied to the header section of the code viewer.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.CodeClass">
            <summary>
            Gets the CSS class name representing the current programming language for syntax highlighting.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.PreClass">
            <summary>
            Gets the CSS class string used for the pre element based on the selected language and line number display settings.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.Code">
            <summary>
            Gets or sets the code snippet to be displayed or processed by the component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.Language">
            <summary>
            Gets or sets the programming language used for syntax highlighting in the code viewer.
            </summary>
            <remarks>Set this property to specify which language's syntax rules are applied when rendering code. The default is C#.
            </remarks>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.ShowLineNumbers">
            <summary>
            Gets or sets a value indicating whether line numbers are displayed in the code viewer.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.ShowHeader">
            <summary>
            Gets or sets a value indicating whether the header is displayed in the code viewer component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.HeaderClass">
            <summary>
            Gets or sets the CSS class string applied to the header section of the code viewer, allowing for custom styling of the header.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.HeaderContent">
            <summary>
            Gets or sets the content to be rendered in the header section of the component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.ShowCopyButton">
            <summary>
            Gets or sets a value indicating whether the copy button is displayed in the code viewer component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.Wrap">
            <summary>
            Gets or sets a value indicating whether the code content should wrap to the next line when it exceeds the
            container width.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.EnableDefaultBackground">
            <summary>
            Gets or sets a value indicating whether the default background should be enabled for the component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.ChildContent">
            <summary>
            Gets or sets the content to be rendered inside this component.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.Editable">
            <summary>
            Gets or sets a value indicating whether the content is editable by the user.
            </summary>
        </member>
        <member name="P:MudExtensions.MudCodeViewer.CodeChanged">
            <summary>
            Gets or sets the callback that is invoked when the code value changes.
            </summary>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.OnAfterRenderAsync(System.Boolean)">
            <summary>
            Invoked after the component has rendered. Performs post-render logic, such as refreshing data, when the
            component is rendered for the first time.
            </summary>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.RefreshAsync">
            <summary>
            Asynchronously refreshes the code viewer by reapplying syntax highlighting to the displayed code.
            </summary>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.CopyAsync">
            <summary>
            Asynchronously copies the current code content to the user's clipboard using JavaScript interop.
            </summary>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.ParameterChanged">
            <summary>
            Handles changes to component parameters asynchronously and refreshes the component state.
            </summary>
        </member>
        <member name="M:MudExtensions.MudCodeViewer.HandleCopyButtonClickAsync">
            <summary>
            Handles the copy button click event asynchronously, updates the copy icon to indicate success, and restores the
            original icon after a brief delay.
            </summary>
        </member>
    </members>
</doc>