Class

RadControl

Declaration

public RadControl()

Declaration

protected Rectangle invalidResizeRect

Field Value

Declaration

protected bool isAccessibilityRequested

Field Value

Declaration

protected bool isDisposing2

Field Value

Declaration

protected bool isResizing2

Field Value

Indicates focus cues display, when available, based on the corresponding control type and the current UI state.

Declaration

[Browsable(true)]
public virtual bool AllowShowFocusCues { get; set; }

Property Value

Gets or sets the Analytics Name associated with this control. By default the Control Name property is logged. If you want to customize the information which will be logged for this control set this property to a preferred value.

Declaration

[Browsable(false)]
public virtual string AnalyticsName { get; set; }

Property Value

Implements IAnalyticsProvider.AnalyticsName

Gets or sets a value indicating whether the control is automatically resized to display its entire contents.

Declaration

[Browsable(true)]
public override bool AutoSize { get; set; }

Property Value

Overrides Control.AutoSize

Gets or sets the BackColor of the control. This is actually the BackColor property of the root element.

Declaration

public override Color BackColor { get; set; }

Property Value

Overrides Control.BackColor

Gets the input behavior for the control.

Declaration

[Browsable(false)]
public ComponentInputBehavior Behavior { get; }

Property Value

Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.

Declaration

public bool CausesValidation { get; set; }

Property Value

Declaration

[TypeConverter(typeof(ExpandableObjectConverter))]
public InputBindingsCollection CommandBindings { get; }

Property Value

Declaration

[Browsable(false)]
public virtual ComponentThemableElementTree ElementTree { get; }

Property Value

Gets or sets a value indicating whether the Analytics functionality is enabled or disabled for this control.

Declaration

[Browsable(true)]
public virtual bool EnableAnalytics { get; set; }

Property Value

Implements IAnalyticsProvider.EnableAnalytics

Gets or sets a value indicating whether the CodedUI Tests functionality is enabled.

Declaration

[Browsable(true)]
public virtual bool EnableCodedUITests { get; set; }

Property Value

Gets or sets the default value for EnableCodedUITests property.

Declaration

[Browsable(true)]
public static bool EnableCodedUITestsDefaultValue { get; set; }

Property Value

Gets or sets a value indicating whether the RadControls scaling logic will be used when the application is run in a high DPI environment.

Declaration

public static bool EnableDpiScaling { get; set; }

Property Value

Gets or sets a value indicating whether the RadControls scaling logic will be used to resize the images when the application is run in a high DPI environment.

Declaration

public static bool EnableImageDpiScaling { get; set; }

Property Value

Gets or sets whether Key Map (Office 2007 like accelerator keys map) is used for this specific control. Currently this option is implemented for the RadRibbonBar control only.

Declaration

[Browsable(true)]
public virtual bool EnableKeyMap { get; set; }

Property Value

Gets or sets a value indicating whether the RadControls Accessible custom object is enabled.

Declaration

[Browsable(false)]
public virtual bool EnableRadAccessibilityObjects { get; set; }

Property Value

Gets or sets a value that indicates whether to use the new auto-scaling mechanism or not. Enabled by default.

Declaration

public static bool EnableRadAutoScale { get; set; }

Property Value

Do not modify. For internal use only.

Declaration

public static bool EnableRadFormInitialDpiScaling { get; set; }

Property Value

Gets or sets a value indicating whether the RadControls will draw use the SvgImages in ImagePrimitive and LightVisualElement objects, or if [false] will draw the corresponding Image property if applicable.

Declaration

public static bool EnableSvgImages { get; set; }

Property Value

Gets or sets value indicating whether the control is styled through theme

Declaration

public bool EnableTheming { get; set; }

Property Value

Gets or sets a value indicating whether the UI Automation functionality is enabled.

Declaration

[Browsable(true)]
public virtual bool EnableUIAutomation { get; set; }

Property Value

Gets or sets the default value for EnableUIAutomation property.

Declaration

[Browsable(true)]
public static bool EnableUIAutomationDefaultValue { get; set; }

Property Value

Declaration

public virtual bool Focusable { get; set; }

Property Value

Declaration

[Browsable(false)]
public RadElement FocusedElement { get; set; }

Property Value

Gets or sets the Font of the control. This is actually the Font property of the root element.

Declaration

public override Font Font { get; set; }

Property Value

Overrides Control.Font

Gets or sets the ForeColor of the control. This is actually the ForeColor property of the root element.

Declaration

public override Color ForeColor { get; set; }

Property Value

Overrides Control.ForeColor

Gets or sets the ImageList that contains the images displayed by this control.

Declaration

[Browsable(true)]
public virtual ImageList ImageList { get; set; }

Property Value

Implements IComponentTreeHandler.ImageList

Gets or sets the image scaling size.

Declaration

[Browsable(false)]
public Size ImageScalingSize { get; set; }

Property Value

Implements IComponentTreeHandler.ImageScalingSize

Declaration

[Browsable(false)]
public bool IsDesignMode { get; }

Property Value

Determines whether the control is currently displayed on the screen.

Declaration

[Browsable(false)]
public bool IsDisplayed { get; }

Property Value

Declaration

[Browsable(false)]
public bool IsInitializing { get; }

Property Value

Determines whether the control is properly loaded.

Declaration

[Browsable(false)]
public bool IsLoaded { get; }

Property Value

Gets or sets the size that is the upper limit that GetPreferredSize can specify.

Declaration

public override Size MaximumSize { get; set; }

Property Value

Overrides Control.MaximumSize

Gets or sets the size that is the lower limit that GetPreferredSize can specify

Declaration

public override Size MinimumSize { get; set; }

Property Value

Overrides Control.MinimumSize

Gets or sets padding within the control.

Declaration

public Padding Padding { get; set; }

Property Value

Gets the RootElement of the control.

Declaration

[Browsable(true)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public RootRadElement RootElement { get; }

Property Value

Implements IComponentTreeHandler.RootElement

Gets or sets a value indicating whether ToolTips are shown for the RadItem objects contained in the RadControl.

Declaration

public virtual bool ShowItemToolTips { get; set; }

Property Value

Declaration

public override ISite Site { get; set; }

Property Value

Overrides Control.Site

Gets or sets the SmallImageList that contains the small images which are displayed when there's not enough space.

Declaration

[Browsable(true)]
public virtual ImageList SmallImageList { get; set; }

Property Value

Implements IComponentTreeHandler.SmallImageList

Gets or sets the small image scaling size.

Declaration

[Browsable(false)]
public Size SmallImageScalingSize { get; set; }

Property Value

Implements IComponentTreeHandler.SmallImageScalingSize

Declaration

[Browsable(true)]
[Bindable(true)]
[SettingsBindable(true)]
public override string Text { get; set; }

Property Value

Overrides Control.Text

Gets or sets the class name string that ThemeResolutionService will use to find the themes registered for the control.

Declaration

public virtual string ThemeClassName { get; set; }

Property Value

Remarks

Gets or sets control's preferred theme name. Themes are stored and retrieved using APIs of ThemeResolutionService.

Declaration

[Browsable(true)]
public virtual string ThemeName { get; set; }

Property Value

Implements IComponentTreeHandler.ThemeName

Remarks

Determines whether to use compatible text rendering engine (GDI+) or not (GDI).

Declaration

public virtual bool UseCompatibleTextRendering { get; set; }

Property Value

Set or get the default value for UseCompatibleTextRendering property.

Declaration

public static bool UseCompatibleTextRenderingDefaultValue { get; set; }

Property Value

Declaration

protected bool ValidationCancel { get; }

Property Value

Suspends layout during initialization.

Declaration

public virtual void BeginInit()

Implements ISupportInitialize.BeginInit()

Determines whether an element may be edited via the EditUIElements dialog at design-time.

Declaration

protected virtual bool CanEditElementAtDesignTime(RadElement element)

Parameters

Returns

Declaration

protected virtual void Construct()

Creates the input behavior instance. Allows inheritors to provide custom input implementations.

Declaration

protected virtual ComponentInputBehavior CreateBehavior()

Returns

Declaration

protected virtual void CreateChildItems(RadElement parent)

Parameters

Declaration

protected virtual RootRadElement CreateRootElement()

Returns

Disable firing gesture events of the specified type.

Declaration

public void DisableGesture(GestureType type)

Parameters

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides Control.Dispose(bool)

Enable firing gesture events of the specified type.

Declaration

public void EnableGesture(GestureType type)

Parameters

Resumes layout.

Declaration

public virtual void EndInit()

Implements ISupportInitialize.EndInit()

Declaration

protected virtual bool FindPropertyInChildren(RadControl radControl, IPCMessage request)

Parameters

Returns

Declaration

protected virtual RadElement GetInputElement()

Returns

Gets the DPI scale factor for the monitor where the specified control is currently displayed.

Declaration

protected virtual SizeF GetMonitorDpiScaleFactor(Control control)

Parameters

Returns

Remarks

Strips all html tags of the text set to the control and returns only the plain text.

Declaration

public string GetPlainText()

Returns

Declaration

public override Size GetPreferredSize(Size proposedSize)

Parameters

Returns

Overrides Control.GetPreferredSize(Size)

Declaration

protected virtual Size GetRootElementDesiredSize(int x, int y, int width, int height)

Parameters

Returns

Declaration

protected virtual void InitializeRootElement(RootRadElement rootElement)

Parameters

Declaration

public void InvokeLayoutCallback(LayoutCallback callback)

Parameters

Implements ILayoutHandler.InvokeLayoutCallback(LayoutCallback)

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides Control.IsInputKey(Keys)

Loads the element tree. While not loaded, no layout operations are allowed upon the tree. By default, the tree will be loaded when the control is displayed for the first time.

Declaration

public virtual void LoadElementTree()

Implements IComponentTreeHandler.LoadElementTree()

Loads the element tree using the specified desired size.

Declaration

public virtual void LoadElementTree(Size desiredSize)

Parameters

Implements IComponentTreeHandler.LoadElementTree(Size)

Declaration

protected override void OnAutoSizeChanged(EventArgs e)

Parameters

Overrides Control.OnAutoSizeChanged(EventArgs)

Declaration

protected override void OnBackColorChanged(EventArgs e)

Parameters

Overrides Control.OnBackColorChanged(EventArgs)

Declaration

protected override void OnBindingContextChanged(EventArgs e)

Parameters

Overrides Control.OnBindingContextChanged(EventArgs)

Declaration

protected virtual void OnCaptureLosing()

Declaration

protected override void OnClick(EventArgs e)

Parameters

Overrides Control.OnClick(EventArgs)

Declaration

protected override void OnCreateControl()

Overrides Control.OnCreateControl()

Declaration

protected override void OnDoubleClick(EventArgs e)

Parameters

Overrides Control.OnDoubleClick(EventArgs)

Declaration

protected override void OnEnabledChanged(EventArgs e)

Parameters

Overrides Control.OnEnabledChanged(EventArgs)

Declaration

protected override void OnFontChanged(EventArgs e)

Parameters

Overrides Control.OnFontChanged(EventArgs)

Declaration

protected override void OnForeColorChanged(EventArgs e)

Parameters

Overrides Control.OnForeColorChanged(EventArgs)

Declaration

protected virtual void OnGesture(GestureEventArgs args)

Parameters

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides Control.OnGotFocus(EventArgs)

Declaration

protected override void OnHandleDestroyed(EventArgs e)

Parameters

Overrides Control.OnHandleDestroyed(EventArgs)

Declaration

protected virtual void OnInvalidated(RadElement element)

Parameters

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides Control.OnKeyDown(KeyEventArgs)

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides Control.OnKeyPress(KeyPressEventArgs)

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Overrides Control.OnKeyUp(KeyEventArgs)

Declaration

protected override void OnLayout(LayoutEventArgs e)

Parameters

Overrides ScrollableControl.OnLayout(LayoutEventArgs)

Notifies that the control is about to be visualized.

Declaration

protected virtual void OnLoad(Size desiredSize)

Parameters

Declaration

protected override void OnLocationChanged(EventArgs e)

Parameters

Overrides Control.OnLocationChanged(EventArgs)

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides Control.OnLostFocus(EventArgs)

Declaration

protected override void OnMouseCaptureChanged(EventArgs e)

Parameters

Overrides Control.OnMouseCaptureChanged(EventArgs)

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides Control.OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseEnter(EventArgs e)

Parameters

Overrides Control.OnMouseEnter(EventArgs)

Declaration

protected override void OnMouseHover(EventArgs e)

Parameters

Overrides Control.OnMouseHover(EventArgs)

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Overrides Control.OnMouseLeave(EventArgs)

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides Control.OnMouseMove(MouseEventArgs)

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides Control.OnMouseUp(MouseEventArgs)

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides ScrollableControl.OnMouseWheel(MouseEventArgs)

Declaration

protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Raises the PropertyChanged event

Declaration

protected virtual void OnNotifyPropertyChanged(string propertyName)

Parameters

Declaration

protected override void OnPaddingChanged(EventArgs e)

Parameters

Overrides ScrollableControl.OnPaddingChanged(EventArgs)

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Overrides Control.OnPaint(PaintEventArgs)

Fires the PanGesture event.

Declaration

protected virtual void OnPanGesture(PanGestureEventArgs args)

Parameters

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Overrides Control.OnParentChanged(EventArgs)

Fires the PressAndTapGesture event.

Declaration

protected virtual void OnPressAndTapGesture(PressAndTapGestureEventArgs args)

Parameters

Declaration

protected override void OnPreviewKeyDown(PreviewKeyDownEventArgs e)

Parameters

Overrides Control.OnPreviewKeyDown(PreviewKeyDownEventArgs)

Declaration

protected override void OnRightToLeftChanged(EventArgs e)

Parameters

Overrides ScrollableControl.OnRightToLeftChanged(EventArgs)

Fires the RotateGesture event.

Declaration

protected virtual void OnRotateGesture(RotateGestureEventArgs args)

Parameters

Declaration

protected virtual void OnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)

Parameters

Declaration

protected virtual void OnThemeChanged()

Declaration

protected virtual void OnThemeNameChanged(ThemeNameChangedEventArgs e)

Parameters

Declaration

protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)

Parameters

Fires the TwoFingerTapGesture event.

Declaration

protected virtual void OnTwoFingerTapGesture(GestureEventArgs args)

Parameters

Declaration

protected override void OnVisibleChanged(EventArgs e)

Parameters

Overrides ScrollableControl.OnVisibleChanged(EventArgs)

Fires the ZoomGesture event.