smart-html-elements

Window Blazor API

Window Properties

Name	Type	Default	Description
AddNewTab	bool	false	Determines if 'Add New' Tab inside the Tabs element is visible. Applicable only to TabsWindow
AutoCapitalize	WindowAutoCapitalize	WindowAutoCapitalize.None	Determines whether and how the value should be automatically capitalized as it is entered/edited by the user. Applicable only to MultilinePromptWindow.
AutoExpand	bool	false	Determines whether element will auto expand when the input overflows vertically. Applicable only to MultilinePromptWindow.
CancelLabel	string	"Cancel"	Determines the label for the 'cancel' button inside the Prompt Window.
CompleteLabel	string	"Confirm"	Determines the label for the 'Complete' button insinde the Progress Window.
ConfirmLabel	string	"Confirm"	Determines the label for the 'Confirm' button insinde the Prompt Window.
IsCollapsed	bool	false	Determines if the window is collapsed or not. When collapsed the only the header of the window is visible.
CloseOnMaskClick	bool	false	When a modal window is opened, thid property determines if clicking on the mask closes the window or not.
DataSource	IEnumerable<object>	N/A	Determines the data source that will be loaded to the TabsWindow. Applicable only to TabsWindow.
Disabled	bool	false	Enables or disables the window.
DisableSnap	bool	false	Enables or disables the window snapping feature.
DisplayMode	WindowDisplayMode	WindowDisplayMode.Default	Determines how the characters are displayed inside the input. Applicable to Prompt Window.
DropPosition	WindowDropPosition	WindowDropPosition.	Applicable to TabsWindow when docked inside a DockingLayout Custom Element. Determines where the window(it's tab items as well) can be dropped inside the DockingLayout. The property is an array that accepts multiple positions. Note: Positions with prefix 'layout-' are applied to the Tab item children of the TabsWidnow owner that is being dragged. The rest of the positions indicate the allowed drop position inside the hovered target(TabsWindow). Used only by SmartDockingLayout custom elements. Determines the possible drop position inside the DockingLayout. The following values are allowed.
FormatFunction	object	N/A	A callback function defining the new format for the label of the Progress Bar. Applicable only to ProgressWindow.
FooterPosition	WindowFooterPosition	WindowFooterPosition.Top	Determines the position of the footer of the window element.
FooterTemplate	object	N/A	Determines the template for the Dialog section of the window. By default footerTemplate is null.
HeaderButtons	string[]	new string[]{}	Set's the buttons that will be visible in the header section.
HeaderTemplate	object	N/A	Determines the template for the Dialog section of the window. By default headerTemplate is null.
HeaderPosition	TabPosition	TabPosition.Top	Determines the position of the header of the window element.
Hint	object	N/A	Sets additional helper text below the text box. The hint is visible only when the text box is focued. Applicable to Prompt Window.
Indeterminate	bool	false	Sets the value of the Progress bar to indeterminate state(null) and starts the animation. Applicable only to ProgressWindow.
Inverted	bool	false	Sets the filling direction of the Progress Bar. Applicable only to ProgressWindow.
Label	string	""	The label of the window that appears in the header area.
LiveResize	bool	false	When enabled the resizing operation happens live. By default it's not enabled and during resizing a highlighter around the edges of the window appears to outline the current size of the element.
Layout	object	N/A	Applicable only to TabsWindow when used with a DockingLayout custom element.Used only by SmartDockingLayout. Determines the owner SmartDockingLayout that the window belongs to. When the tabsWindow has been removed from a DockingLayout element, the property is used to indicate that it belongs to that particular Dockinglayout. Accepts a string, representing the ID of a SmartDockingLayout on the page, or an instance of SmartDokcingLayout.
Locale	string	"en"	Sets or gets the language. Used in conjunction with the property messages.
Locked	bool	false	Applicable only to TabsWindow when docked inside a DockingLayout Custom Element.Determines of the item can be resized or not.
IsMaximized	bool	false	Determines if the window is maximized or not. When maximized the window covers the whole viewport.
Messages	object	N/A	Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
Modal	bool	false	Determines if the window is modal or not. If true the user can only interact with the window and nothing else on the page.
Max	object		Applicable to TabsWindow when docked inside a DockingLayout Custom Element. Determines the max size of the item. Applicable to Progress Window by allowing the user to specify the maximum of the ProgressBar.
Min	object		Applicable to TabsWindow when docked inside DockingLayout Custom Element. Determines the min size of the item. Applicable to Progress Window by allowing the user to specify the minimu of the ProgressBar.
IsMinimized	bool	false	Determines if the window is minimized or not. When minimized the window is docked at the bottom left corner of the viewport.
MaxLength	int	N/A	Sets or gets the maximum number of characters that the user can enter. Applicable to Prompt/MultilinePrompt Window.
MinLength	int	2	Sets or gets the minimum number of characters that the user have to enter to trigger the auto complete functionality. Applicable to Prompt/MultilinePrompt Window.
IsOpened	bool	false	Determines if the window is visible or not.
Pinned	bool	false	Determines if the window is pinned or not. Pinned window is a window that can't be dragged but can be resized.
Placeholder	string	""	Determines the input's placeholder. Applicable to Prompt Window.
PromptLabel	string	""	Determines the label for the Input insinde the PromptWindow.
Readonly	bool	false	If the element is readonly, users cannot interact with it.
ResizeIndicator	bool	false	When applied a resize indicator is displayed in the bottom right corner of the window and resizing operation can be initiated only from its position.
ResizeMode	WindowResizeMode	WindowResizeMode.None	Determines the resizing mode of the window. Several modes are available: none - resizing is disabled. vertical - vertical resizing is allowed. horizontal - horizontal resizing is allowed. both - horizontal and vertical resizing is allowed. top - the window can only be resized from the top side. bottom - the window is resizable only from the bottom side. left - the window can be resized only from the left side. right - the window can be resized only from the right side.
RightToLeft	bool	false	Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
Required	bool	false	Specifies that the user must fill the input before submitting a form with the text box.Applicable to Prompt Window.
RequiredMessage	string	""	Specifies the message that will appear if required is set and no value is provided in the input. Applicable to Prompt Window.
SelectAllOnFocus	bool	false	Determines whether the content of the input will be selected on focus or not. Applicable to Prompt Window.
SelectedIndex	int?	N/A	Sets or gets which tab is selected. Applicable only to TabsWindow.
SelectionMode	TabSelectionMode	TabSelectionMode.Click	Determines the way the user can switch between tabs. Applicable only to TabsWindow.
SelectionEnd	int	0	Indicates the index of the last character in the current selection. Applicable only to MultilinePromptWindow.
SelectionStart	int	0	Indicates the index to the first character in the current selection. Applicable only to MultilinePromptWindow.
ShowProgressValue	bool	false	Enables/Disabled the label for the Progress Bar. Applicable only to Progress Window.
Siblings	object[]	new Collection<object[]>()	A getter that returns the siblings (that share the same parent) of a LayoutPanel item that is docked inside a DockingLayout. The siblings are also DockingLayout items ( LayoutPanels).Applicable only to TabsWindow when docked inside a DockingLayout.
Size	string	""	Applicable to TabsWindow when nested inside a DockingLayout Custom Element. Determines the size of the item.
SpellCheck	bool	false	Specifies whether the element is to have its spelling and grammar checked or not. Applicable only to MultilinePromptWindow.
TabCloseButtons	bool	false	Sets or gets whether close buttons are displayed inside the Tab Strip of the TabsWindow. Applicable only to TabsWindow.
TabCloseButtonMode	WindowTabCloseButtonMode	WindowTabCloseButtonMode.Default	Determines if the close button is visible on select or always. Applicable only to TabsWindow.
TabOverflow	Overflow	Overflow.Auto	Sets or gets the Tabs scroll buttons behavior. Applicable only when tabLayout is 'scroll'. Applicable only to TabsWindow.
TabPosition	TabPosition	TabPosition.Top	Detetmines Tab Strip is positioned of the TabsWindow. Applicable only to TabsWindow.
TabScrollButtonsPosition	LayoutPosition	LayoutPosition.Both	Sets or gets the position of the scroll buttons inside the Tab header of the TabsWindow. Applicable only to TabsWindow.
TabTextOrientation	Orientation	Orientation.Horizontal	Sets or gets the orientation of the text in the tabs labels of the TabsWindow. Applicable only to TabsWindow.
Theme	string	""	Determines the theme. Theme defines the look of the element
Unfocusable	bool	false	If is set to true, the element cannot be focused.
Value	object		Determines the value of the TextBox/ProgressBar inside the Dialog/Prompt/Progress Window
WindowParent	object	N/A	Determines the actual parent of the element. The window can size and move only in the area of that element.
Wrap	WindowWrap	WindowWrap.Soft	Indicates how the input wraps text. Applicable only to MultilinePromptWindow.

Window Methods

Name	Type	Arguments	Description
AppendChild	dynamic	dynamic node	Appends a tabitem to the end of the list of tab items inside element.Args: dynamic node - A TabItem element that should be added to the rest of the items as the last item.
BringToFront	void	N/A	Sets the window to the top level so the user can interact with it.
Clear	void	N/A	Clears the content of the Window.
Close	void	N/A	Closes the window.
Collapse	object	N/A	Collapses the window.
EnsureVisible	void	int index	Makes sure a tab item is visible by scrolling to it. "Applicable only to TabsWindow."Args: int index - The index of the tab to scroll to.
Expand	IEnumerable<object>	N/A	Expands the window after being collapsed.
GetDataSourceAsync()	Task<IEnumerable<object>>	'N/A'	Gets the "DataSource" property as Task<IEnumerable<object>>.
GetIsCollapsedAsync()	Task<bool>	'N/A'	Gets the "IsCollapsed" property as Task<bool>.
GetIsOpenedAsync()	Task<bool>	'N/A'	Gets the "IsOpened" property as Task<bool>.
GetSelectedIndexAsync()	Task<int?>	'N/A'	Gets the "SelectedIndex" property as Task<int?>.
GetValueAsync()	Task<object>	'N/A'	Gets the "Value" property as Task<object>.
Insert	void	int index, object details	Inserts a new tab and an associated content section. "Applicable only to TabsWindow."Args: int index - The index to insert a new tab at.,object details - An Object with the fields "label", "labelSize", "content" and "group".
InsertBefore	dynamic	dynamic newNode, dynamic referenceNode	Inserts the specified "smart-tab-item" node before the reference "smart-tab-item" node. "Applicable only to TabsWindow."Args: dynamic newNode - The "smart-tab-item" node to insert.,dynamic referenceNode - The "smart-tab-item" node before which newNode is inserted.
InsertBefore	dynamic	dynamic newNode	Inserts the specified "smart-tab-item" node before the reference "smart-tab-item" node. Applicable only to TabsWindow.
Maximize	void	N/A	Maximizes the window to fill the area.
Minimize	void	N/A	Minimizes the window.
Open	void	N/A	Opens the window
Pin	void	N/A	Pins the window. Disables window dragging.
Refresh	void	'N/A'	Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
RemoveAt	void	int index	Removes a tab and its associated content section. "Applicable only to TabsWindow."Args: int index - The index of the tab to remove.
RemoveChild	dynamic	dynamic node	Removes a child "smart-tab-item" node. "Applicable only to TabsWindow."Args: dynamic node - The "smart-tab-item" node to remove.
Render	void	'N/A'	Re-renders the Blazor Component. This method will make a full re-render.
Restore	void	N/A	Restores the window to it's previous size before maximization/minimization.
Select	void	int index	Selects a tab. " Applicalbe only to TabsWindow elements."Args: int index - The index of the tab to select.
StateHasChanged	void	'N/A'	Refreshes the state and Re-renders the Blazor Component, if necessary.
Unpin	void	N/A	Unpins the window. Enables window dragging.
Update	void	int index, string label, string content	Updates a tab and its associated content section. " Applicalbe only to TabsWindow elements."Args: int index - The index of the tab to update.,string label - The new label of the tab. The value can be the id of an HTMLTemplateElement,string content - The new content of the tab.

Window Events

Name	Type	Description	Event Detail
OnOpening	EventCallback<Event>	This event is triggered just before the window starts opening.	N/A
Opening	event WindowOpeningEventHandler	This event is triggered just before the window starts opening.	WindowOpeningEventArgs
OnOpen	EventCallback<Event>	This event is triggered when the window is opened( visible ).	N/A
Opened	event WindowOpenedEventHandler	This event is triggered when the window is opened( visible ).	WindowOpenedEventArgs
OnClosing	EventCallback<Event>	This event is triggered just before the window starts closing.	N/A
Closing	event WindowClosingEventHandler	This event is triggered just before the window starts closing.	WindowClosingEventArgs
OnClose	EventCallback<Event>	This event is triggered when the window is closed( hidden )	N/A
Closed	event WindowClosedEventHandler	This event is triggered when the window is closed( hidden )	WindowClosedEventArgs
OnCollapse	EventCallback<Event>	This event is triggered when the window is collapsed.	N/A
Collapsed	event WindowCollapsedEventHandler	This event is triggered when the window is collapsed.	WindowCollapsedEventArgs
OnDragEnd	EventCallback<Event>	This event is triggered when window's dragging is ended.	N/A
DragEnded	event WindowDragEndedEventHandler	This event is triggered when window's dragging is ended.	WindowDragEndedEventArgs
OnDragStart	EventCallback<Event>	This event is triggered when window's dragging is started.	N/A
DragStarted	event WindowDragStartedEventHandler	This event is triggered when window's dragging is started.	WindowDragStartedEventArgs
OnExpand	EventCallback<Event>	This event is triggered when the window is expanded.	N/A
Expanded	event WindowExpandedEventHandler	This event is triggered when the window is expanded.	WindowExpandedEventArgs
OnMaximize	EventCallback<Event>	This event is triggered when the window is maximized.	N/A
Maximized	event WindowMaximizedEventHandler	This event is triggered when the window is maximized.	WindowMaximizedEventArgs
OnMinimize	EventCallback<Event>	This event is triggered when the window is minimized.	N/A
Minimized	event WindowMinimizedEventHandler	This event is triggered when the window is minimized.	WindowMinimizedEventArgs
OnResizeEnd	EventCallback<Event>	This event is triggered when window's resizing is ended.	N/A
ResizeEnded	event WindowResizeEndedEventHandler	This event is triggered when window's resizing is ended.	WindowResizeEndedEventArgs
OnResizeStart	EventCallback<Event>	This event is triggered when window's resizing is started.	N/A
ResizeStarted	event WindowResizeStartedEventHandler	This event is triggered when window's resizing is started.	WindowResizeStartedEventArgs
OnRestore	EventCallback<Event>	This event is triggered when the window is restored to it's previous state before maximization.	N/A
Restored	event WindowRestoredEventHandler	This event is triggered when the window is restored to it's previous state before maximization.	WindowRestoredEventArgs