StreetSmartGUI Class

The StreetSmartGUI class is the UserControl within Street Smart runs. This class can be added to a Panel within your application.

Definition

Namespace: StreetSmart.WinForms
Assembly: StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 24.7.0.0+cc0a01953d1235087ce28d3e921f5bb47d3c0460
C#
public sealed class StreetSmartGUI : UserControl
Inheritance
Object    MarshalByRefObject    Component    Control    ScrollableControl    ContainerControl    UserControl    StreetSmartGUI

Example

This sample shows how to use the StreetSmartGUI UserControl.
C#
using System;
using StreetSmart.WinForms;
using StreetSmart.WinForms.Factories;
using StreetSmart.WinForms.Interfaces;

namespace Demo
{
  public class Example
  {
    private IStreetSmartAPI _api;
    private System.Windows.Forms.Panel _plStreetSmart = new System.Windows.Forms.Panel();

    public void StartAPI()
    {
      _api = StreetSmartAPIFactory.Create();
      _api.APIReady += OnAPIReady;

      // _api.GUI is the StreetSmartGUI UserControl
      StreetSmartGUI gui = _api.GUI;
      _plStreetSmart.Controls.Add(gui);
    }

    private void OnAPIReady(object sender, EventArgs args)
    {
      // API ready
      // Todo: add functionality
    }
  }
}

Properties

AccessibilityObjectGets the AccessibleObject assigned to the control.
(Inherited from Control)
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications.
(Inherited from Control)
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications.
(Inherited from Control)
AccessibleNameGets or sets the name of the control used by accessibility client applications.
(Inherited from Control)
AccessibleRoleGets or sets the accessible role of the control.
(Inherited from Control)
ActiveControlGets or sets the active control on the container control.
(Inherited from ContainerControl)
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it.
(Inherited from Control)
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
(Inherited from Control)
AutoScaleDimensionsGets or sets the dimensions that the control was designed to.
(Inherited from ContainerControl)
AutoScaleModeGets or sets the automatic scaling mode of the control.
(Inherited from ContainerControl)
AutoScrollGets or sets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries.
(Inherited from ScrollableControl)
AutoScrollMarginGets or sets the size of the auto-scroll margin.
(Inherited from ScrollableControl)
AutoScrollMinSizeGets or sets the minimum size of the auto-scroll.
(Inherited from ScrollableControl)
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control).
(Inherited from Control)
AutoScrollPositionGets or sets the location of the auto-scroll position.
(Inherited from ScrollableControl)
AutoSizeThis property is not relevant for this class.
(Inherited from UserControl)
AutoSizeModeGets or sets how the control will resize itself.
(Inherited from UserControl)
AutoValidateGets or sets how the control performs validation when the user changes focus to another control.
(Inherited from UserControl)
BackColorGets or sets the background color for the control.
(Inherited from Control)
BackgroundImageGets or sets the background image displayed in the control.
(Inherited from Control)
BackgroundImageLayoutGets or sets the background image layout as defined in the ImageLayout enumeration.
(Inherited from Control)
BindingContextGets or sets the BindingContext for the control.
(Inherited from ContainerControl)
BorderStyleGets or sets the border style of the user control.
(Inherited from UserControl)
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
(Inherited from Control)
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
(Inherited from Control)
CanFocusGets a value indicating whether the control can receive focus.
(Inherited from Control)
CanSelectGets a value indicating whether the control can be selected.
(Inherited from Control)
CaptureGets or sets a value indicating whether the control has captured the mouse.
(Inherited from Control)
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
(Inherited from Control)
ClientRectangleGets the rectangle that represents the client area of the control.
(Inherited from Control)
ClientSizeGets or sets the height and width of the client area of the control.
(Inherited from Control)
CompanyNameGets the name of the company or creator of the application containing the control.
(Inherited from Control)
ContainerGets the IContainer that contains the Component.
(Inherited from Component)
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus.
(Inherited from Control)
ContextMenuStripGets or sets the ContextMenuStrip associated with this control.
(Inherited from Control)
ControlsGets the collection of controls contained within the control.
(Inherited from Control)
CreatedGets a value indicating whether the control has been created.
(Inherited from Control)
CurrentAutoScaleDimensionsGets the current run-time dimensions of the screen.
(Inherited from ContainerControl)
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control.
(Inherited from Control)
DataBindingsGets the data bindings for the control.
(Inherited from Control)
DataContextGets or sets the data context for the purpose of data binding. This is an ambient property.
(Inherited from Control)
DeviceDpiGets the DPI value for the display device where the control is currently being displayed.
(Inherited from Control)
DisplayRectangleGets the rectangle that represents the virtual display area of the control.
(Inherited from ScrollableControl)
DisposingGets a value indicating whether the base Control class is in the process of disposing.
(Inherited from Control)
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
(Inherited from Control)
EnabledGets or sets a value indicating whether the control can respond to user interaction.
(Inherited from Control)
FocusedGets a value indicating whether the control has input focus.
(Inherited from Control)
FontGets or sets the font of the text displayed by the control.
(Inherited from Control)
ForeColorGets or sets the foreground color of the control.
(Inherited from Control)
HandleGets the window handle that the control is bound to.
(Inherited from Control)
HasChildrenGets a value indicating whether the control contains one or more child controls.
(Inherited from Control)
HeightGets or sets the height of the control.
(Inherited from Control)
HorizontalScrollGets the characteristics associated with the horizontal scroll bar.
(Inherited from ScrollableControl)
ImeModeGets or sets the Input Method Editor (IME) mode of the control.
(Inherited from Control)
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on.
(Inherited from Control)
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications.
(Inherited from Control)
IsAncestorSiteInDesignModeIndicates if one of the Ancestors of this control is sited and that site in DesignMode. This property is read-only.
(Inherited from Control)
IsDisposedGets a value indicating whether the control has been disposed of.
(Inherited from Control)
IsHandleCreatedGets a value indicating whether the control has a handle associated with it.
(Inherited from Control)
IsMirroredGets a value indicating whether the control is mirrored.
(Inherited from Control)
LayoutEngineGets a cached instance of the control's layout engine.
(Inherited from Control)
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
(Inherited from Control)
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
(Inherited from Control)
MarginGets or sets the space between controls.
(Inherited from Control)
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify.
(Inherited from Control)
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify.
(Inherited from Control)
NameGets or sets the name of the control.
(Inherited from Control)
PaddingGets or sets padding within the control.
(Inherited from Control)
ParentGets or sets the parent container of the control.
(Inherited from Control)
ParentFormGets the form that the container control is assigned to.
(Inherited from ContainerControl)
PreferredSizeGets the size of a rectangular area into which the control can fit.
(Inherited from Control)
ProductNameGets the product name of the assembly containing the control.
(Inherited from Control)
ProductVersionGets the version of the assembly containing the control.
(Inherited from Control)
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle.
(Inherited from Control)
RegionGets or sets the window region associated with the control.
(Inherited from Control)
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
(Inherited from Control)
RightToLeftGets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
(Inherited from Control)
SiteGets or sets the site of the control.
(Inherited from Control)
SizeGets or sets the height and width of the control.
(Inherited from Control)
TabIndexGets or sets the tab order of the control within its container.
(Inherited from Control)
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key.
(Inherited from Control)
TagGets or sets the object that contains data about the control.
(Inherited from Control)
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
(Inherited from Control)
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
(Inherited from Control)
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls.
(Inherited from Control)
VerticalScrollGets the characteristics associated with the vertical scroll bar.
(Inherited from ScrollableControl)
VisibleGets or sets a value indicating whether the control and all its child controls are displayed.
(Inherited from Control)
WidthGets or sets the width of the control.
(Inherited from Control)

Methods

BeginInvoke(Action)Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control)
BeginInvoke(Delegate)Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control)
BeginInvoke(Delegate, Object)Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
(Inherited from Control)
BringToFrontBrings the control to the front of the z-order.
(Inherited from Control)
ContainsRetrieves a value indicating whether the specified control is a child of the control.
(Inherited from Control)
CreateControlForces the creation of the visible control, including the creation of the handle and any visible child controls.
(Inherited from Control)
CreateGraphicsCreates the Graphics for the control.
(Inherited from Control)
DisposeReleases all resources used by the Component.
(Inherited from Component)
DoDragDrop(Object, DragDropEffects)Begins a drag-and-drop operation.
(Inherited from Control)
DoDragDrop(Object, DragDropEffects, Bitmap, Point, Boolean)Begins a drag operation.
(Inherited from Control)
DrawToBitmapSupports rendering to the specified bitmap.
(Inherited from Control)
EndInvokeRetrieves the return value of the asynchronous operation represented by the IAsyncResult passed.
(Inherited from Control)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FindFormRetrieves the form that the control is on.
(Inherited from Control)
FocusSets input focus to the control.
(Inherited from Control)
GetChildAtPoint(Point)Retrieves the child control that is located at the specified coordinates.
(Inherited from Control)
GetChildAtPoint(Point, GetChildAtPointSkip)Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
(Inherited from Control)
GetContainerControlReturns the next ContainerControl up the control's chain of parent controls.
(Inherited from Control)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Obsolete.
GetNextControlRetrieves the next control forward or back in the tab order of child controls.
(Inherited from Control)
GetPreferredSizeRetrieves the size of a rectangular area into which a control can be fitted.
(Inherited from Control)
GetTypeGets the Type of the current instance.
(Inherited from Object)
HideConceals the control from the user.
(Inherited from Control)
InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Obsolete.
InvalidateInvalidates the entire surface of the control and causes the control to be redrawn.
(Inherited from Control)
Invalidate(Boolean)Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control)
Invalidate(Rectangle)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control)
Invalidate(Region)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control)
Invalidate(Rectangle, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control)
Invalidate(Region, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control)
Invoke(Action)Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control)
Invoke(Delegate)Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control)
Invoke(Delegate, Object)Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
(Inherited from Control)
InvokeT(FuncT)Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control)
LogicalToDeviceUnits(Int32)Converts a Logical DPI value to its equivalent DeviceUnit DPI value.
(Inherited from Control)
LogicalToDeviceUnits(Size)Transforms a size from logical to device units by scaling it for the current DPI and rounding down to the nearest integer value for width and height.
(Inherited from Control)
PerformAutoScalePerforms scaling of the container control and its children.
(Inherited from ContainerControl)
PerformLayoutForces the control to apply layout logic to all its child controls.
(Inherited from Control)
PerformLayout(Control, String)Forces the control to apply layout logic to all its child controls.
(Inherited from Control)
PointToClientComputes the location of the specified screen point into client coordinates.
(Inherited from Control)
PointToScreenComputes the location of the specified client point into screen coordinates.
(Inherited from Control)
PreProcessControlMessagePreprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control)
PreProcessMessagePreprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control)
RectangleToClientComputes the size and location of the specified screen rectangle in client coordinates.
(Inherited from Control)
RectangleToScreenComputes the size and location of the specified client rectangle in screen coordinates.
(Inherited from Control)
RefreshForces the control to invalidate its client area and immediately redraw itself and any child controls.
(Inherited from Control)
ResetTextResets the Text property to its default value (Empty).
(Inherited from Control)
ResumeLayoutResumes usual layout logic.
(Inherited from Control)
ResumeLayout(Boolean)Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
(Inherited from Control)
ScaleScales the control and all child controls by the specified scaling factor.
(Inherited from Control)
ScaleBitmapLogicalToDeviceScales a logical bitmap value to it's equivalent device unit value when a DPI change occurs.
(Inherited from Control)
ScrollControlIntoViewScrolls the specified child control into view on an auto-scroll enabled control.
(Inherited from ScrollableControl)
SelectActivates the control.
(Inherited from Control)
SelectNextControlActivates the next control.
(Inherited from Control)
SendToBackSends the control to the back of the z-order.
(Inherited from Control)
SetAutoScrollMarginSets the size of the auto-scroll margins.
(Inherited from ScrollableControl)
SetBounds(Int32, Int32, Int32, Int32)Sets the bounds of the control to the specified location and size.
(Inherited from Control)
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)Sets the specified bounds of the control to the specified location and size.
(Inherited from Control)
ShowDisplays the control to the user.
(Inherited from Control)
SuspendLayoutTemporarily suspends the layout logic for the control.
(Inherited from Control)
ToStringReturns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
UpdateCauses the control to redraw the invalidated regions within its client area.
(Inherited from Control)
ValidateVerifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order.
(Inherited from ContainerControl)
Validate(Boolean)Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on.
(Inherited from ContainerControl)
ValidateChildrenCauses all of the child controls within a control that support validation to validate their data.
(Inherited from UserControl)
ValidateChildren(ValidationConstraints)Causes all of the child controls within a control that support validation to validate their data.
(Inherited from UserControl)

Events

AutoSizeChangedOccurs when the AutoSize property changes.
(Inherited from UserControl)
AutoValidateChangedOccurs when the AutoValidate property changes.
(Inherited from UserControl)
BackColorChangedOccurs when the value of the BackColor property changes.
(Inherited from Control)
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes.
(Inherited from Control)
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes.
(Inherited from Control)
BindingContextChangedOccurs when the value of the BindingContext property changes.
(Inherited from Control)
CausesValidationChangedOccurs when the value of the CausesValidation property changes.
(Inherited from Control)
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change.
(Inherited from Control)
ClickOccurs when the control is clicked.
(Inherited from Control)
ClientSizeChangedOccurs when the value of the ClientSize property changes.
(Inherited from Control)
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes.
(Inherited from Control)
ControlAddedOccurs when a new control is added to the ControlControlCollection.
(Inherited from Control)
ControlRemovedOccurs when a control is removed from the ControlControlCollection.
(Inherited from Control)
CursorChangedOccurs when the value of the Cursor property changes.
(Inherited from Control)
DataContextChangedOccurs when the value of the DataContext property changes.
(Inherited from Control)
DisposedOccurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)
DockChangedOccurs when the value of the Dock property changes.
(Inherited from Control)
DoubleClickOccurs when the control is double-clicked.
(Inherited from Control)
DpiChangedAfterParentOccurs when the DPI setting for a control is changed programmatically after the DPI of its parent control or form has changed.
(Inherited from Control)
DpiChangedBeforeParentOccurs when the DPI setting for a control is changed programmatically before a DPI change event for its parent control or form has occurred.
(Inherited from Control)
DragDropOccurs when a drag-and-drop operation is completed.
(Inherited from Control)
DragEnterOccurs when an object is dragged into the control's bounds.
(Inherited from Control)
DragLeaveOccurs when an object is dragged out of the control's bounds.
(Inherited from Control)
DragOverOccurs when an object is dragged over the control's bounds.
(Inherited from Control)
EnabledChangedOccurs when the Enabled property value has changed.
(Inherited from Control)
EnterOccurs when the control is entered.
(Inherited from Control)
FontChangedOccurs when the Font property value changes.
(Inherited from Control)
ForeColorChangedOccurs when the ForeColor property value changes.
(Inherited from Control)
GiveFeedbackOccurs during a drag operation.
(Inherited from Control)
GotFocusOccurs when the control receives focus.
(Inherited from Control)
HandleCreatedOccurs when a handle is created for the control.
(Inherited from Control)
HandleDestroyedOccurs when the control's handle is in the process of being destroyed.
(Inherited from Control)
HelpRequestedOccurs when the user requests help for a control.
(Inherited from Control)
ImeModeChangedOccurs when the ImeMode property has changed.
(Inherited from Control)
InvalidatedOccurs when a control's display requires redrawing.
(Inherited from Control)
KeyDownOccurs when a key is pressed while the control has focus.
(Inherited from Control)
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus.
(Inherited from Control)
KeyUpOccurs when a key is released while the control has focus.
(Inherited from Control)
LayoutOccurs when a control should reposition its child controls.
(Inherited from Control)
LeaveOccurs when the input focus leaves the control.
(Inherited from Control)
LoadOccurs before the control becomes visible for the first time.
(Inherited from UserControl)
LocationChangedOccurs when the Location property value has changed.
(Inherited from Control)
LostFocusOccurs when the control loses focus.
(Inherited from Control)
MarginChangedOccurs when the control's margin changes.
(Inherited from Control)
MouseCaptureChangedOccurs when the control loses mouse capture.
(Inherited from Control)
MouseClickOccurs when the control is clicked by the mouse.
(Inherited from Control)
MouseDoubleClickOccurs when the control is double clicked by the mouse.
(Inherited from Control)
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed.
(Inherited from Control)
MouseEnterOccurs when the mouse pointer enters the control.
(Inherited from Control)
MouseHoverOccurs when the mouse pointer rests on the control.
(Inherited from Control)
MouseLeaveOccurs when the mouse pointer leaves the control.
(Inherited from Control)
MouseMoveOccurs when the mouse pointer is moved over the control.
(Inherited from Control)
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released.
(Inherited from Control)
MouseWheelOccurs when the mouse wheel moves while the control has focus.
(Inherited from Control)
MoveOccurs when the control is moved.
(Inherited from Control)
PaddingChangedOccurs when the control's padding changes.
(Inherited from Control)
PaintOccurs when the control is redrawn.
(Inherited from Control)
ParentChangedOccurs when the Parent property value changes.
(Inherited from Control)
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control.
(Inherited from Control)
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications.
(Inherited from Control)
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
(Inherited from Control)
RegionChangedOccurs when the value of the Region property changes.
(Inherited from Control)
ResizeOccurs when the control is resized.
(Inherited from Control)
RightToLeftChangedOccurs when the RightToLeft property value changes.
(Inherited from Control)
ScrollOccurs when the user or code scrolls through the client area.
(Inherited from ScrollableControl)
SizeChangedOccurs when the Size property value changes.
(Inherited from Control)
StyleChangedOccurs when the control style changes.
(Inherited from Control)
SystemColorsChangedOccurs when the system colors change.
(Inherited from Control)
TabIndexChangedOccurs when the TabIndex property value changes.
(Inherited from Control)
TabStopChangedOccurs when the TabStop property value changes.
(Inherited from Control)
TextChangedOccurs when the Text property value changes.
(Inherited from Control)
ValidatedOccurs when the control is finished validating.
(Inherited from Control)
ValidatingOccurs when the control is validating.
(Inherited from Control)
VisibleChangedOccurs when the Visible property value changes.
(Inherited from Control)

Version Information

Supported in: 18.7

See Also