Version

EmbeddableEditorOwnerBase Class Members

The following tables list the members exposed by EmbeddableEditorOwnerBase.

Public Properties
 NameDescription
Public PropertyDesignModeReturns true if in design mode, false otherwise.  
Public Methods
 NameDescription
Public MethodAccessibilityNotifyClientsNotifies the owner that an accessible event has occurred.  
Public MethodAlwaysRaiseEditorButtonEventsThis method indicates whether editor buttons should always fire editor button events even if the editor is not in edit mode. Default implementation returns false.  
Public MethodAreTouchMetricsEnabledReturns whether this editor should display using Touch metrics or not.  
Public MethodCanProcessMouseWheelIndicates whether the editor should respond to the mouse wheel.  
Public MethodDrawAsActiveReturns whether the element should be drawn as if it were in its "active" state. Only applicable if the return from the DisplayStyle property is not Standard.  
Public MethodEnsureValueIsInListReturns whether an editor's value must correspond to an item in its ValueList  
Public MethodEnterEditModeOnClickIf true is returned, the editor will enter edit mode on either MouseDown or MouseUp, depending on the nature of the editor  
Public MethodGetAutoCompleteModeReturns the AutoCompleteMode constant which determines the automatic completion mode for the EditorWithCombo editor.  
Public MethodGetAutoEditIndicates whether AutoEdit should enabled.  
Public MethodGetAutoSizeEditInfoReturns the AutoSizeEdit information to be used by editors that support AutoSizing  
Public MethodGetAutoSuggestFilterModeReturns the AutoSuggestFilterMode constant which determines the filtering mode for the EditorWithCombo embeddable editor's auto-complete functionality.  
Public MethodGetBorderStyleReturns the BorderStyle to be used by the editor's embeddable element  
Public MethodGetButtonStyleReturns the ButtonStyle to be used by the embeddable element's button  
Public MethodGetCachedGraphicsCalled to get a graphics object suitable for doing metrics calculations only.  
Public MethodGetCharacterCasingDetermines how the text will be cased.  
Public MethodGetCheckedListSettingsReturns an object which determines whether checkboxes are displayed for the items in a ValueList, and defines the properties and behavior for the checkboxes.  
Public MethodGetComponentRoleInvoked by an editor to obtain the application style information.  
Public MethodGetConstraintsReturns a ValueConstraint object associated with the owner context, if any.  
Public MethodGetContextMenuReturns the ContextMenu that will be displayed by the editor  
Public MethodGetContextMenuStripReturns the ContextMenuStrip that will be displayed by the editor  
Public MethodGetControlReturns the owner's control.  
Public MethodGetDataTypeReturns the data type.  
Public MethodGetDisplayStyleReturns the DisplayStyle to be used by the embeddable element  
Public MethodGetDropDownListAdditionalWidthReturns the number of pixels by which to increase the dropdown list's width to compensate for borders, etc.  
Public MethodGetDropDownListOffsetReturns the horizontal and vertical offset to apply to the DropDown's list  
Public MethodGetEditorReturns the editor for the passed in ownerContext. This is used by the base implementation of EmbeddableOwnerBase.  
Public MethodGetEditorContextGets the editor context that was set with SetEditorContext method.  
Public MethodGetEditorElementReturns the embeddable uielement associated with a particular object or null if none is available.  
Public MethodGetExtendedInfoReturns owner-specific information to an editor  
Public MethodGetExternalContextReturns an object that may be provided to the programmer using an editor.  
Public MethodGetFormatInfoReturns information needed to format a string.  
Public MethodGetGlyphInfoReturns a GlyphInfo object which assists in the drawing of glyphs such as CheckBoxes and Radio buttons.  
Public MethodGetImageListReturns the image list to be used by the editor's ValueList, or null  
Public MethodGetImageTransparentColorReturns the color that is used as the transparent color for images displayed by the editor  
Public MethodGetImeModeGets the ImeMode value used for the editor.  
Public MethodGetMaskInfoReturns masking information. This is only of ibterest to a editor that supports masking.  
Public MethodGetMaxLengthReturns the maximum length for a string.  
Public MethodGetMaxLinesReturns the maximum number of text lines displayed.  
Public MethodGetMaxValueReturns the maximum allowable value.  
Public MethodGetMinValueReturns the minimum allowable value.  
Public MethodGetNullTextThe string to display for a null value.  
Public MethodGetPadCharReturns character used as a substitute for spaces.  
Public MethodGetPaddingThe padding to place around the value to display.  
Public MethodGetPasswordCharReturns the character used to mask characters.  
Public MethodGetPromptCharReturns the character used as prompt during editing (e.g. '_').  
Public MethodGetScrollBarLookReturns the Infragistics.Win.UltraWinScrollBar.ScrollBarLook to be used by the scrollbars displayed by the embeddable editor.  
Public MethodGetScrollBarViewStyleReturns the Infragistics.Win.UltraWinScrollBar.ScrollBarViewStyle that the editor should utilize for any scrollbars that it displays.  
Public MethodGetShowInkButtonDetermines when to show the Ink Button on the editor.  
Public MethodGetSizeOfImagesReturns the size of images to be used by the editor's ValueList  
Public MethodGetSpellCheckerGets the spell checker  
Public MethodGetTextBoxScrollBarsReturns which scrollbars should appear in an editor's multiline TextBox.  
Public MethodGetTextRenderingModeReturns the text rendering mode to use. Default implementation returns Default value.  
Public MethodGetTypeConverterReturns the type converter to use to convert values. The default implementation returns the type converter associated with the data type of the owner.  
Public MethodGetValueReturns the value that should be rendered.  
Public MethodGetValueListReturns a list of predefined values.  
Public MethodGetValueListsCollectionReturns the image list to be used by the editor's ValueList, or null  
Public MethodIsActionableAreaSupportedInvoked by an editor to determine if an area of the element that performs an action is supported.  
Public MethodIsEditorAlwaysInEditModeReturns whether this editor is always in edit mode  
Public MethodIsEnabledReturns whether the value is enabled for editing.  
Public MethodIsHotTrackingEnabledReturns whether "hot tracking" effects should be enabled  
Public MethodIsKeyMappedReturns whether the key is used by the owner.  
Public MethodIsMultiLineReturns whether the text is multiline.  
Public MethodIsNullableReturns whether the value can be set to null.  
Public MethodIsPrintingReturns true if the editor is being used in printing. The default is false.  
Public MethodIsReadOnlyReturns true is the value is read-only  
Public MethodIsVerticalReturns whether the element should display vertical.  
Public MethodMustDisplayFromListReturns whether the text an element displays must correspond to the text of an item in a list  
Public MethodMustSelectFromListReturns whether a selection can only be made from the value list.  
Public MethodOnEditorClickThe editor calls this method whenever any of its embeddable elements gets a click.  
Public MethodOnEditorDoubleClickThe editor calls this method whenever any of its embeddable elements gets a double click.  
Public MethodOnEditorGotFocusCalled when the editor gets focus.  
Public MethodOnEditorLostFocusCalled when the editor loses focus.  
Public MethodOnEditorMouseDownThe editor calls this method whenever any of its embeddable elements gets a mouse down.  
Public MethodOnEditorMouseUpThe editor calls this method whenever any of its embeddable elements gets a mouse up.  
Public MethodOnEnterEditorCalled when focus is entering the editor.  
Public MethodOnLeaveEditorCalled when focus is leaving the editor.  
Public MethodRaiseKeyDownRases KeyDown event.  
Public MethodRaiseKeyPressRaises KeyPress event.  
Public MethodRaiseKeyUpRaises KeyUp event.  
Public MethodReleaseCachedGraphicsCalled to release a graphics object that was returned from a prior call to GetCachedGraphics.  
Public MethodResolveAppearanceOverloaded. Resolves the appearance for an element.  
Public MethodResolveDefaultAppearanceResolves the default appearance for an element.  
Public MethodSetEditorContextSets the editor context for the passed in ownerContext.  
Public MethodShouldDrawFocusDetermines if a focus rect should be drawn.  
Public MethodShouldShowOverflowIndicatorSets the out parameters to values relating to the overflow indicator's existence and if it should show a tooltip.  
Public MethodShowHotkeyPrefixReturns whether the ampersand character is interpreted as a hotkey prefix.  
Public MethodShowKeyboardCuesReturns whether the UI is in a proper state to show keyboard accelerators.  
Public MethodSuppressEnterLeaveInvalidationBy default the editors will invalidate the embeddable editor elements as the mouse enters and leaves them. This method can be used to suppress this behavior. Default implementation returns false.  
Public MethodUseDefaultEditorCursorReturns whether the editor should use its default cursor  
Public MethodWrapTextReturns whether the text should be wrapped if it doesn't fit.  
Public Events
 NameDescription
Public EventKeyDownOccurs on a key down while the editor is in edit mode and the owner has focus.  
Public EventKeyPressOccurs on a key press while the editor is in edit mode and the owner has focus.  
Public EventKeyUpOccurs on a key up while the editor is in edit mode and the owner has focus.  
See Also