Skip to main content

VisualControl

The VisualControl class represents a base visual control with properties related to visibility, styling, and interactivity.

Properties

NameDescription
LoadingIndicates whether the control is in a loading state.
ContextMenuColumnKeyThe key of the column associated with the context menu.
ContextMenuKeyThe key associated with the context menu.
StyleThe styling properties for the control.
ExecutedServerEventsA list of server events that have been executed.
DefaultEnabledIndicates whether the control is enabled by default.
ClientEnabledIndicates whether the control is enabled on the client side.
TitleThe title of the control.
VisibleIndicates whether the control is visible.
ContextMenuTargetThe target of the context menu.
ContainerStyleThe styling properties for the container of the control.
ServerEventsA list of server-side events associated with the control.
NameThe name of the control.
DefaultClientEnabledIndicates whether the control is enabled by default on the client side.
ClientEventsA list of client-side events associated with the control.
EnabledIndicates whether the control is enabled.
ControlIdThe unique identifier of the control.
ClientVisibleIndicates whether the control is visible on the client side.
CustomClassNameThe custom CSS class name applied to the control.
CaptionThe caption of the control.

Constructors

NameDescription
BaseControl()Initializes a new instance of the VisualControl class with default values.
VisualControl()Initializes a new instance of the VisualControl class with empty event lists.

Methods

NameDescription
OnDoubleClick(sender, e)Raises the DoubleClick event.
OnPropertyChanged(sender, e)Handles the property changed event.
ToggleLoading()Toggles the loading state of the control.
FireClick()Triggers the Click event.
GetDifferences(otherObj)Compares the current instance with another control and returns the differences.
OnClick(sender, e)Raises the Click event.
OnPropertyValueGet(sender, e)Raises the PropertyValueGet event.
OnPropertyChanging(sender, e)Handles the property changing event.
OnLoad(sender, e)Raises the Load event.
Hide()Hides the control.
SetPropertyValue(mapping, value)Sets the value of a property specified by a mapping.
HideLoading()Removes the loading state from the control.
OnRender(sender, e)Raises the Render event.
Show()Makes the control visible.
GetProtectedData(isDisabledOrReadOnly)#import (Bimser.CSP.FormControls.Base.ICanProtectData.GetProtectedData(bool)) (shortDescription)
OnPreRender(sender, e)Raises the PreRender event.
ShowLoading()Sets the control to a loading state.
ScrollTo()Scrolls to the control.
OnInit(sender, e)Raises the Init event.

Events

NameDescription
LoadTriggered when the control is loaded.
ClickTriggered when the control is clicked.
PropertyValueGetTriggered when retrieving a control property value.
DoubleClickTriggered when the control is double-clicked.
PreRenderTriggered before the control is rendered.
RenderTriggered when the control is rendered.
InitTriggered when the control is initialized.