Ribbon for WinForms | ComponentOne
C1.Framework Namespace / IconElement Class
Fields Properties Methods


In This Topic
    IconElement Class Members
    In This Topic

    The following tables list the members exposed by IconElement.

    Protected Fields
     NameDescription
    Protected Field_boundsThe System.Drawing.Rectangle that defines the position of the Element within its parent. (Inherited from C1.Framework.Element)
    Protected Field_flagsAn Element.ElementFlags value that defines the behavior of this Element. (Inherited from C1.Framework.Element)
    Protected Field_parentThe parent Element. (Inherited from C1.Framework.Element)
    Protected Field_styleThe Element.Style object that defines the appearance of this Element. (Inherited from C1.Framework.Element)
    Protected FieldDEFAULT_HEIGHTThe default height of an icon.  
    Protected FieldDEFAULT_WIDTHThe default width of an icon.  
    Top
    Public Properties
     NameDescription
    Public PropertyAutoHeightGets or sets the System.Boolean value specifying whether element height is automatically determined by its style and contents. (Inherited from C1.Framework.Element)
    Public PropertyAutoSizeGets the System.Boolean value specifying whether element size is automatically determined by its style and contents. (Inherited from C1.Framework.Element)
    Public PropertyAutoWidthGets or sets the System.Boolean value specifying whether element width is automatically determined by its style and contents. (Inherited from C1.Framework.Element)
    Public PropertyBackColorGets or sets the color used to paint the icon's background.  
    Public PropertyBoundsGets or sets the element's bounds (size and location) within its parent element, in pixels. (Inherited from C1.Framework.Element)
    Public PropertyChildrenGets a list of child elements. (Inherited from C1.Framework.Element)
    Public PropertyColorGets or sets the color used to paint the icon.  
    Public PropertyContainsFocusGets a value that indicates whether this Element or one of its children has the focus. (Inherited from C1.Framework.Element)
    Public PropertyContentBoundsClient rectangle, in pixels. This discounts margins, borders, and padding. (Inherited from C1.Framework.Element)
    Public PropertyEnabledGets or sets whether the element is enabled (can receive mouse and keyboard messages). (Inherited from C1.Framework.Element)
    Public PropertyFocusableGets or sets whether the element is focusable (receives keyboard messages). (Inherited from C1.Framework.Element)
    Public PropertyFocusedGets a value that indicates whether this Element has the focus. (Inherited from C1.Framework.Element)
    Public PropertyForceLineBreakGets a Element.LineBreak value that determines whether there should be line breaks before and/or after this Element when it occurs in a paragraph. (Inherited from C1.Framework.Element)
    Public PropertyHasChildrenGets a value that indicates the element has a non-empty Element.Children collection. (Inherited from C1.Framework.Element)
    Public PropertyHeightElement height. Set to -1 to let the element calculate it automatically. (Inherited from C1.Framework.Element)
    Public PropertyHitTestableGets or sets whether the element is hit-testable (receives mouse messages). (Inherited from C1.Framework.Element)
    Public PropertyHostControlGets the System.Windows.Forms.Control that is hosting this Element. (Inherited from C1.Framework.Element)
    Public PropertyHostViewGets the IView that is hosting this Element. (Inherited from C1.Framework.Element)
    Public PropertyInheritedRtlGets or sets whether the value of RightToLeft property is inherited from the parent element. (Inherited from C1.Framework.Element)
    Public PropertyIsDirtyGets a value that indicates this element needs to be laid out. (Inherited from C1.Framework.Element)
    Public PropertyIsEnabledGets whether this element and all its ancestors are enabled. (Inherited from C1.Framework.Element)
    Public PropertyIsFocusableGets whether this element can currently receive the focus. (Inherited from C1.Framework.Element)
    Public PropertyIsHotGets or sets whether the element should be displayed using the Style.Hot style. (Inherited from C1.Framework.Element)
    Public PropertyIsPressedGets or sets whether the element should be displayed using the Style.Pressed style. (Inherited from C1.Framework.Element)
    Public PropertyIsVisibleGets whether this element and all its ancestors are visible. (Inherited from C1.Framework.Element)
    Public PropertyKeyGets or sets the key used to retrieve the image.  
    Public PropertyLeftGets or sets the horizontal position of the element within its parent. (Inherited from C1.Framework.Element)
    Public PropertyLineDescentGets the portion of the element that renders below the baseline. Usually non-zero only for text elements, depends on font. (Inherited from C1.Framework.Element)
    Public PropertyLocationGets or sets the location of the element within its parent. (Inherited from C1.Framework.Element)
    Public PropertyPaddingGets or sets the padding of the icon.  
    Public PropertyParentGets the element's parent, or null if this is the root element. (Inherited from C1.Framework.Element)
    Public PropertyRenderStyleGets the element's style, or a default style if the element doesn't have one. This never returns null. (Inherited from C1.Framework.Element)
    Public PropertyRightToLeftGets or sets whether the element should be drawn using right-to-left layout. (Inherited from C1.Framework.Element)
    Public PropertyRootGets the element's top-level parent. (Inherited from C1.Framework.Element)
    Public PropertyShowFocusRectangleGets or sets whether the element should display a focus rectangle when it has focus. (Inherited from C1.Framework.Element)
    Public PropertySizeGets or sets the size of the element. (Inherited from C1.Framework.Element)
    Public PropertyStyleGets or sets the Style object used to render this Element. (Inherited from C1.Framework.Element)
    Public PropertyTopGets or sets the vertical position of the element within its parent. (Inherited from C1.Framework.Element)
    Public PropertyValidatedGets or sets a value indicating if the contents was successfully validated. (Inherited from C1.Framework.Element)
    Public PropertyVisibleGets or sets whether the element is visible. (Inherited from C1.Framework.Element)
    Public PropertyWidthElement width. Set to -1 to let the element calculate it automatically. (Inherited from C1.Framework.Element)
    Top
    Protected Properties
     NameDescription
    Protected PropertyIsIconDirty  
    Protected PropertyRenderBoxReturns rectangle (in the icon coordinates) to render icon.  
    Protected PropertyShouldDispose  
    Protected PropertyShouldRasterizeDetermines whether icon needs bitmap cache for drawing.  
    Protected PropertyShouldResizeDetermines whether icon image should be resized according to the C1Icon element size.  
    Top
    Public Methods
     NameDescription
    Public MethodCloneReturns a clone of this element. (Inherited from C1.Framework.Element)
    Public Methodstatic (Shared in Visual Basic)CreateElementOverloaded. Creates the IconElement to show the C1Icon.  
    Public MethodFocusSets the focus to the host control and to this Element within the host control. (Inherited from C1.Framework.Element)
    Public MethodGetBoundsOverloaded. Gets the element's bounds (size and location) within an arbitrary ancestor, in pixels. Ancestor element (parent, grand-parent, etc). A System.Drawing.Rectangle that corresponds to the element's position within the given ancestor. (Inherited from C1.Framework.Element)
    Public MethodGetFlags (Inherited from C1.Framework.Element)
    Public MethodGetParent<T>Navigates up the tree to find an ancestor of a given type. (Inherited from C1.Framework.Element)
    Public MethodGetParentOfTypeNavigates up the tree to find an ancestor of a given type. (Inherited from C1.Framework.Element)
    Public MethodGetScrollOriginReturns the scroll origin (override to implement non-scrolling areas). (Inherited from C1.Framework.Element)
    Public MethodHitTestReturns the element at a given point. (Inherited from C1.Framework.Element)
    Public MethodInvalidateOverloaded. Invalidates this Element within the host control. (Inherited from C1.Framework.Element)
    Public MethodIsChildOfDetermines whether this element is a child of another element. (Inherited from C1.Framework.Element)
    Public MethodIsInputKeyDetermines whether the specified key is a regular input key or a special key that requires preprocessing. (Inherited from C1.Framework.Element)
    Public MethodLayoutOverloaded. Overridden. Lays out this element based on its style and contents.  
    Public MethodMeasureOverloaded. Provides the size, in pixels, of the specified content drawn on the specified System.Drawing.Graphics surface. (Inherited from C1.Framework.Element)
    Public MethodOffsetAdjusts the location of this element by the specified amount. (Inherited from C1.Framework.Element)
    Public MethodOnClickCalled by the host control when the user clicks this Element. (Inherited from C1.Framework.Element)
    Public MethodOnDoubleClickCalled by the host control when the user double-clicks this Element. (Inherited from C1.Framework.Element)
    Public MethodOnGotFocusCalled by the host control when this Element receives the focus. (Inherited from C1.Framework.Element)
    Public MethodOnKeyDownCalled by the host control when the user presses a key and this Element has the focus. (Inherited from C1.Framework.Element)
    Public MethodOnKeyPressCalled by the host control when the user presses a character key and this Element has the focus. (Inherited from C1.Framework.Element)
    Public MethodOnKeyUpCalled by the host control when the user releases a key and this Element has the focus. (Inherited from C1.Framework.Element)
    Public MethodOnLostFocusCalled by the host control when this Element loses the focus. (Inherited from C1.Framework.Element)
    Public MethodOnMouseDownCalled by the host control when the user presses a mouse button over this Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseEnterCalled by the host control when the mouse enters this Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseEnterHoverCalled by the host control when the mouse enters this Element, even if another element has captured the mouse. (Inherited from C1.Framework.Element)
    Public MethodOnMouseLeaveCalled by the host control when the mouse leaves this Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseLeaveHoverCalled by the host control when the mouse leaves this Element, even if another element has captured the mouse. (Inherited from C1.Framework.Element)
    Public MethodOnMouseLostCaptureCalled by the host control when the user releases the left mouse button over a disabled Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseMoveCalled by the host control when the mouse moves over this Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseUpCalled by the host control when the user releases a mouse button over this Element. (Inherited from C1.Framework.Element)
    Public MethodOnMouseWheelHandles MouseWheel events. (Inherited from C1.Framework.Element)
    Public MethodOnValidatedCalled by the host control after the element has been validated. (Inherited from C1.Framework.Element)
    Public MethodOnValidatingCalled by the host control when the element is about to lose focus. (Inherited from C1.Framework.Element)
    Public MethodPointToClientComputes the location of the specified screen point into client coordinates. (Inherited from C1.Framework.Element)
    Public MethodPointToScreenComputes the location of the specified client point into screen coordinates. (Inherited from C1.Framework.Element)
    Public MethodRenderRenders the element into a given rectangle. (Inherited from C1.Framework.Element)
    Public MethodRenderChildrenRenders the child elements into a given rectangle. (Inherited from C1.Framework.Element)
    Public MethodRenderContentOverridden. Renders the element contents into the specified System.Drawing.Graphics object at the specified location.  
    Public MethodSetDirtyOverloaded. Marks this element as dirty, forcing all parent and child elements to be laid out. (Inherited from C1.Framework.Element)
    Public MethodSetFlagsOverloaded.  (Inherited from C1.Framework.Element)
    Public MethodToStringGets a string representation of this C1BitmapIcon.  
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalizeUIOverridden. Finalizes the user interface. This method is called when element is removed from UI.  
    Protected MethodGetBorderPathGets a System.Drawing.Drawing2D.GraphicsPath that covers only the borders (hollow, used to renders the borders). (Inherited from C1.Framework.Element)
    Protected MethodGetDeviceDPIGets the DPI value for the display device where the Element.HostControl is currently being displayed. (Inherited from C1.Framework.Element)
    Protected MethodGetImageGets the image represented by this C1Icon.  
    Protected MethodInitializeUIInitializes the UI.  
    Protected MethodOnIconChangedUpdates element properties on icon property changes.  
    Protected MethodOnRightToLeftChanged (Inherited from C1.Framework.Element)
    Protected MethodOnStateChangedCalled by the host control when the state of this Element changes. (Inherited from C1.Framework.Element)
    Protected MethodRenderIcon  
    Protected MethodRescaleConstantsForDpiOverridden. Provides constants for rescaling the Element when a DPI change occurs.  
    Protected MethodScaleToDeviceDPIOverloaded. Scales the Style instance uses the DeviceDpi value if this element has a Element.HostControl. (Inherited from C1.Framework.Element)
    Protected MethodSetIconDirtyNotifies C1Icon element that UI should be re-initialized for the next drawing operation.  
    Protected MethodUpdateStyle (Inherited from C1.Framework.Element)
    Top
    See Also

    Reference

    IconElement Class
    C1.Framework Namespace