WinForms controls | Beep.Skia Documentation

Complete API surface of the Beep.Skia.Winform.Controls assembly: 42 public types with their documented members. Follow the family guide for usage patterns.

Types in this assembly

SkiaButton class
SkiaCard class
SkiaCascadingMenu class
SkiaCheckBox class
SkiaColorConverter class
SkiaComboBox class
SkiaComponentPropertyWrapper class
SkiaContextMenu class
SkiaControl class
SkiaControlDesigner class
SkiaDataGrid class
SkiaDatePicker class
SkiaEnumConverter class
SkiaFabMenu class
SkiaFloatingActionButton class
SkiaHostControl class
SkiaHostControlActionList class
SkiaHostControlDesigner class
SkiaLabel class
SkiaList class
SkiaMenu class
SkiaMenuBar class
SkiaMenuButton class
SkiaMultiComponentWrapper class
SkiaNavigationBar class
SkiaNavigationDrawer class
SkiaNodePropertyDescriptor class
SkiaPanel class
SkiaProgressBar class
SkiaSearch class
SkiaSegmentedButtons class
SkiaSlider class
SkiaSpinner class
SkiaSplitButton class
SkiaStatusBar class
SkiaSvgImage class
SkiaSwitch class
SkiaTabs class
SkiaTextArea class
SkiaTextBox class
SkiaToggleButton class
SkiaToolBar class

SkiaButton (class)

Design-time wrapper that creates a Skia Button component on the Skia host

Member	Kind	Description
`SkiaButton()`	Method	Initializes a new instance of the SkiaButton class.

SkiaCard (class)

Design-time wrapper that creates a Skia Card component on the Skia host

Member	Kind	Description
`SkiaCard()`	Method	Initializes a new instance of the SkiaCard class.

SkiaCascadingMenu (class)

Skia CascadingMenu wrapper (minimal)

Member	Kind	Description
`SkiaCascadingMenu()`	Method	Initializes a new instance of the SkiaCascadingMenu class.

SkiaCheckBox (class)

Design-time wrapper that creates a Skia Checkbox component on the Skia host

Member	Kind	Description
`SkiaCheckBox()`	Method	Initializes a new instance of the SkiaCheckBox class.

SkiaColorConverter (class)

TypeConverter for SKColor: edits colors as "#AARRGGBB" hex strings in the PropertyGrid.

Member	Kind	Description
`override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)`	Method	Gets or sets the can convert from.
`override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)`	Method	Gets or sets the can convert to.
`override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)`	Method	Gets or sets the convert from.
`override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)`	Method	Gets or sets the convert to.
`static SKColor Parse(string text)`	Method	Parses "#AARRGGBB", "#RRGGBB", or a named color; invalid input returns transparent.
`static string Format(SKColor color)`	Method	Formats a color as "#AARRGGBB".

SkiaComboBox (class)

Design-time wrapper that creates a Skia Dropdown component on the Skia host

Member	Kind	Description
`SkiaComboBox()`	Method	Initializes a new instance of the SkiaComboBox class.

SkiaComponentPropertyWrapper (class)

Wraps a SkiaComponent to expose its NodeProperties in the Visual Studio PropertyGrid. Implements ICustomTypeDescriptor so the VS designer can display editable properties. Edits are applied back to the component (public setters) and reported through the change callback.

Member	Kind	Description
`SkiaComponent Component`	Property	Gets or sets the component.
`string ComponentTypeName`	Property	Gets or sets the component type name.
`string ComponentName`	Property	Gets or sets the component name.
`SkiaComponentPropertyWrapper(SkiaComponent component, Action<SkiaComponent> onChanged = null)`	Method	Initializes a new instance of the SkiaComponentPropertyWrapper class.
`override string ToString()`	Method	Gets or sets the to string.
`void Dispose()`	Method	Gets or sets the dispose.

SkiaContextMenu (class)

Design-time wrapper that creates a Skia ContextMenu component on the Skia host

Member	Kind	Description
`SkiaContextMenu()`	Method	Initializes a new instance of the SkiaContextMenu class.

SkiaControl (class)

Member	Kind	Description
`SkiaComponent SkiaComponent`	Property	Gets or sets the skia component.
`SkiaControl()`	Method	Initializes a new instance of the SkiaControl class.

SkiaControlDesigner (class)

Member	Kind	Description
`override void Initialize(IComponent component)`	Method	Gets or sets the initialize.

SkiaDataGrid (class)

Design-time wrapper that creates a Skia DataGrid component on the Skia host

Member	Kind	Description
`SkiaDataGrid()`	Method	Initializes a new instance of the SkiaDataGrid class.

SkiaDatePicker (class)

Design-time wrapper that creates a Skia DatePicker component on the Skia host

Member	Kind	Description
`SkiaDatePicker()`	Method	Initializes a new instance of the SkiaDatePicker class.

SkiaEnumConverter (class)

TypeConverter that provides a dropdown list of string choices.

Member	Kind	Description
`SkiaEnumConverter(string[] values)`	Method	Initializes a new instance of the SkiaEnumConverter class.
`override bool GetStandardValuesSupported(ITypeDescriptorContext context)`	Method	Gets or sets the get standard values supported.
`override bool GetStandardValuesExclusive(ITypeDescriptorContext context)`	Method	Gets or sets the get standard values exclusive.
`override StandardValuesCollection GetStandardValues(ITypeDescriptorContext context)`	Method	Gets or sets the get standard values.

SkiaFabMenu (class)

Design-time wrapper that creates a Skia FabMenu component on the Skia host

Member	Kind	Description
`SkiaFabMenu()`	Method	Initializes a new instance of the SkiaFabMenu class.

SkiaFloatingActionButton (class)

Design-time wrapper that creates a Skia FloatingActionButton component on the Skia host

Member	Kind	Description
`SkiaFloatingActionButton()`	Method	Initializes a new instance of the SkiaFloatingActionButton class.

SkiaHostControl (class)

Host control that provides a Skia drawing surface and a DrawingManager to host Skia components.

Member	Kind	Description
`int ReloadExtensions()`	Method	Reloads extensions from the install root and refreshes their palette entries. Returns the number of extension components added.
`Beep.Skia.DrawingManager DrawingManager`	Property	Gets or sets the drawing manager.
`SkiaHostControl()`	Method	Initializes a new instance of the SkiaHostControl class.
`void RebuildCommentPins()`	Method	Rebuilds comment pins from the current components and comments.
`void RefreshCommentPins()`	Method	Rebuilds comment pins and repaints the canvas.
`Beep.Skia.Collaboration.DiagramComment AddCommentToSelection(string text, string authorId = "local")`	Method	Adds a comment anchored to the first selected component. Returns null when nothing is selected or the user cannot comment.
`bool ResolveComment(string commentId, string userId = "local")`	Method	Resolves a comment by id and repaints.
`void ExportToPng(string filePath, float scale = 2f)`	Method	Exports the current diagram to a PNG file.
`void ExportToSvg(string filePath)`	Method	Exports the current diagram to an SVG file with a white background.
`void ExportToPdf(string filePath)`	Method	Exports the current diagram to a PDF file.
`void PrintWithPreview()`	Method	Shows a print preview for the current diagram.
`void BeginInit()`	Method	Gets or sets the begin init.
`SkiaComponentDescriptorCollection DesignTimeComponents`	Property	Gets or sets the design time components.
`bool BlockOverlappingDrops`	Property	If true, component creation will be blocked when the new component's bounds overlap an existing component. Default false: overlaps allowed (prevents silent disappearance when dropping in same area).
`Beep.Skia.SkiaComponent CreateAndAddComponent(Type componentType, float x, float y, float width, float height, string name)`	Method	Gets or sets the create and add component.
`Beep.Skia.SkiaComponent CreateAndAddComponentFromDescriptor(SkiaComponentDescriptor desc)`	Method	Gets or sets the create and add component from descriptor.

SkiaHostControlActionList (class)

Smart-tag action list for SkiaHostControl providing design-time verbs.

Member	Kind	Description
`SkiaHostControlActionList(SkiaHostControlDesigner designer)`	Method	Initializes a new instance of the SkiaHostControlActionList class.
`bool ShowGrid`	Property	Gets or sets the show grid.
`bool SnapToGrid`	Property	Gets or sets the snap to grid.
`void ClearAllComponents()`	Method	Gets or sets the clear all components.
`void ResetZoom()`	Method	Gets or sets the reset zoom.
`void ArrangeDiagram()`	Method	Gets or sets the arrange diagram.
`override DesignerActionItemCollection GetSortedActionItems()`	Method	Gets or sets the get sorted action items.

SkiaHostControlDesigner (class)

Design-time designer for SkiaHostControl providing smart-tag verbs.

Member	Kind	Description
`override DesignerActionListCollection ActionLists`	Property	Gets or sets the action lists.
`SkiaHostControl HostControl`	Property	Gets or sets the host control.

SkiaLabel (class)

Design-time wrapper that creates a Skia Label component on the Skia host

Member	Kind	Description
`SkiaLabel()`	Method	Initializes a new instance of the SkiaLabel class.

SkiaList (class)

Design-time wrapper that creates a Skia List component on the Skia host

Member	Kind	Description
`SkiaList()`	Method	Initializes a new instance of the SkiaList class.

SkiaMenu (class)

Design-time wrapper that creates a Skia Menu component on the Skia host

Member	Kind	Description
`SkiaMenu()`	Method	Initializes a new instance of the SkiaMenu class.

SkiaMenuBar (class)

Skia MenuBar wrapper (minimal)

Member	Kind	Description
`SkiaMenuBar()`	Method	Initializes a new instance of the SkiaMenuBar class.

SkiaMenuButton (class)

Skia MenuButton wrapper (minimal)

Member	Kind	Description
`SkiaMenuButton()`	Method	Initializes a new instance of the SkiaMenuButton class.

SkiaMultiComponentWrapper (class)

PropertyGrid wrapper for multiple selected components: exposes geometry plus the NodeProperties common to every selected component; edits apply to all of them.

Member	Kind	Description
`IReadOnlyList<SkiaComponent> Components`	Property	Gets or sets the components.
`int Count`	Property	Gets or sets the count.
`SkiaMultiComponentWrapper(IReadOnlyList<SkiaComponent> components, Action<IReadOnlyList<SkiaComponent>> onChanged = null)`	Method	Initializes a new instance of the SkiaMultiComponentWrapper class.
`override string ToString()`	Method	Gets or sets the to string.
`void Dispose()`	Method	Gets or sets the dispose.

SkiaNavigationBar (class)

Design-time wrapper that creates a Skia NavigationBar component on the Skia host

Member	Kind	Description
`SkiaNavigationBar()`	Method	Initializes a new instance of the SkiaNavigationBar class.

SkiaNavigationDrawer (class)

Skia NavigationDrawer wrapper (minimal)

Member	Kind	Description
`SkiaNavigationDrawer()`	Method	Initializes a new instance of the SkiaNavigationDrawer class.

SkiaNodePropertyDescriptor (class)

Property descriptor for a single SkiaComponent NodeProperty. Supports enum choices, simple type conversion, and SKColor hex editing.

Member	Kind	Description
`SkiaNodePropertyDescriptor(string name, Type type, Func<object> getter, Action<object> setter, string category, string description, string[] choices = null)`	Method	Initializes a new instance of the SkiaNodePropertyDescriptor class.
`override Type ComponentType`	Property	Gets or sets the component type.
`override bool IsReadOnly`	Property	Gets or sets the is read only.
`override Type PropertyType`	Property	Gets or sets the property type.
`override string Description`	Property	Gets or sets the description.
`override string Category`	Property	Gets or sets the category.
`override bool CanResetValue(object component)`	Method	Gets or sets the can reset value.
`override void ResetValue(object component) { }`	Method	Gets or sets the reset value.
`override bool ShouldSerializeValue(object component)`	Method	Gets or sets the should serialize value.
`override object GetValue(object component)`	Method	Gets or sets the get value.
`override void SetValue(object component, object value)`	Method	Gets or sets the set value.
`override TypeConverter Converter`	Property	Gets or sets the converter.

SkiaPanel (class)

Design-time wrapper that creates a Skia Panel component on the Skia host

Member	Kind	Description
`SkiaPanel()`	Method	Initializes a new instance of the SkiaPanel class.

SkiaProgressBar (class)

Skia ProgressBar wrapper (minimal)

Member	Kind	Description
`SkiaProgressBar()`	Method	Initializes a new instance of the SkiaProgressBar class.

SkiaSearch (class)

Skia Search wrapper (minimal)

Member	Kind	Description
`SkiaSearch()`	Method	Initializes a new instance of the SkiaSearch class.

SkiaSegmentedButtons (class)

Skia SegmentedButtons wrapper (minimal)

Member	Kind	Description
`SkiaSegmentedButtons()`	Method	Initializes a new instance of the SkiaSegmentedButtons class.

SkiaSlider (class)

Design-time wrapper that creates a Skia Slider component on the Skia host

Member	Kind	Description
`SkiaSlider()`	Method	Initializes a new instance of the SkiaSlider class.

SkiaSpinner (class)

Design-time wrapper that creates a Skia Spinner component on the Skia host

Member	Kind	Description
`SkiaSpinner()`	Method	Initializes a new instance of the SkiaSpinner class.

SkiaSplitButton (class)

Skia SplitButton wrapper (minimal)

Member	Kind	Description
`SkiaSplitButton()`	Method	Initializes a new instance of the SkiaSplitButton class.

SkiaStatusBar (class)

Design-time wrapper that creates a Skia StatusBar component on the Skia host

Member	Kind	Description
`SkiaStatusBar()`	Method	Initializes a new instance of the SkiaStatusBar class.

SkiaSvgImage (class)

Skia SvgImage wrapper (minimal)

Member	Kind	Description
`SkiaSvgImage()`	Method	Initializes a new instance of the SkiaSvgImage class.

SkiaSwitch (class)

Design-time wrapper that creates a Skia Switch component on the Skia host

Member	Kind	Description
`SkiaSwitch()`	Method	Initializes a new instance of the SkiaSwitch class.

SkiaTabs (class)

Design-time wrapper that creates a Skia Tabs component on the Skia host

Member	Kind	Description
`SkiaTabs()`	Method	Initializes a new instance of the SkiaTabs class.

SkiaTextArea (class)

Skia TextArea wrapper (minimal)

Member	Kind	Description
`SkiaTextArea()`	Method	Initializes a new instance of the SkiaTextArea class.

SkiaTextBox (class)

Design-time wrapper that creates a Skia TextBox component on the Skia host

Member	Kind	Description
`SkiaTextBox()`	Method	Initializes a new instance of the SkiaTextBox class.

SkiaToggleButton (class)

Design-time wrapper that creates a Skia ToggleButton component on the Skia host

Member	Kind	Description
`SkiaToggleButton()`	Method	Initializes a new instance of the SkiaToggleButton class.

SkiaToolBar (class)

Design-time wrapper that creates a Skia ToolBar component on the Skia host

Member	Kind	Description
`SkiaToolBar()`	Method	Initializes a new instance of the SkiaToolBar class.