Version

EmbeddableEditorBase Class Members

The following tables list the members exposed by EmbeddableEditorBase.

Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyCanFocusReturns true if the editor can take focus while in edit mode (read-only).  
Public PropertyCurrentEditTextReturns the current text being edited without doing any validation. This will return the text currently typed in. If the editor does not have an textbox-like control, it will return the current edit value in form of text.  
Public PropertyDataFilterIf different than null, specifies custom data filter used by the editor.  
Public PropertyDefaultOwnerReturns the default embeddable editor owner, which may provide default owner-specific values for an editor  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorSharedObjectNameSpecifies name of the shared object that was defined for this editor.  
Public PropertyElementBeingEditedReturns the embeddable element that is currently in edit mode.  
Public PropertyExpectedTypeDefault type used by the editor in the case of data filter. Null means that editor supports multiple data types and expects type to be set or provided by the owner.  
Public PropertyFocusedReturns true if the editor has focus (read-only).  
Public PropertyIsDroppedDownReturns true if in edit mode and dropped down  
Public PropertyIsInEditModeReturns true if the editor is in edit mode  
Public PropertyIsValidReturns true if the edited value is valid (read-only).  
Public PropertySelectedTextGets or sets the currently selected text in the editor.  
Public PropertySelectionLengthGets or sets the number of characters selected in the editor.  
Public PropertySelectionStartGets or sets the starting point of text selected in the editor.  
Public PropertySupportsAutoSizeEditSpecifies whether the editor supports AutoSizeEdit (read-only).  
Public PropertySupportsDropDownReturns true if this editor supports a dropdown.  
Public PropertySupportsSelectableTextReturns true if this editor supports selecting text.  
Public PropertySupportsSpellCheckingReturns true if this editor supports spell checking.  
Public PropertySupportsValueListSpecifies whether the editor supports value list (read-only).  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextLengthGets the length of the text in the editor.  
Public PropertyValueThe current value being edited. Type matches editor owner data type.  
Protected Properties
 NameDescription
Protected PropertyHasOwnDefaultContextMenuProperty which should be overriden by derived editors which have their own default Context Menu, so an ancestor's ContextMenu would be prevented from showing.  
Protected PropertySelectedTextInternalGets or sets the currently selected text in the editor.  
Protected PropertySelectionLengthInternalGets or sets the number of characters selected in the editor.  
Protected PropertySelectionStartInternalGets or sets the starting point of text selected in the editor.  
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Protected PropertyTextLengthInternalGets the length of the text in the editor.  
Protected PropertyWantsOwnerKeyEventsSpecifies whether the editor wants to receive key events from the owner while in edit mode (read-only).  
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)ApplyToolTipAppearanceApplies tooltip backcolor, forecolor and BackGradientStyle to the specified appearance. It also strips those flags from the requestedPropFlags parameter.  
Public MethodApplyValueAppearanceApplies any appearance associated with the dataVal data value. Base implementation does nothing.  
Public MethodAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control.  
Public MethodCanEditTypeDetermines if the type can be edited.  
Public MethodCanRenderTypeDetermines if the type can be rendered.  
Public MethodCloneCreates a copy of the embeddable editor with the specified default owner.  
Public MethodCloseUpCalled to have the dropdown close up.  
Public MethodComparesByValueReturns whether the owner should compare items based on their underlying value rather than their display text.  
Public MethodCreateAccessibilityInstanceUsed by an editor owner to create an accessible object for a specific object managed by an editor.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodCreateUIAutomationProviderUsed by an editor owner to create a UI Automation provider for a specific object managed by an editor.  
Public MethodDataValueToTextOverloaded. Converts data value to text making use of any format provider and format strings that owner may provide. If unsuccessful, returns null.  
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownCalled to drop down the dropdown.  
Public MethodEnterEditModeCalled to place the editor in edit mode.  
Public MethodExitEditModeCalled to have the editor exit edit mode.  
Public MethodFocusSets input focus to the editor.  
Public MethodGetDropDownStateReturns information about whether the dropdown is dropped down.  
Public MethodGetEditStatusReturns information about whether the object is in edit mode.  
Public MethodGetEmbeddableElementOverloaded. Called from inside the UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements.  
Public MethodGetEmbeddableElementTypeReturns the type of the EmbeddableUIElementBase derived class that this editor uses as it's embeddable element.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetSizeOverloaded. Is called to get the size needed to render a value.  
Public MethodGetSpellCheckTargetGets the current spell check target  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsInputKeyReturns whether the key is used by the editor.  
Public MethodIsValidValueReturns true if the edited value is valid (read-only). If the value is invalid, the 'errorMessage' out parameter can contain an error message.  
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodOnTouchMetricsChangedCalled when the TouchProvider's state or registration has changed (e.g. when its Visble or Enabled property has changed).  
Public MethodSelectAllSelects all text in the editor.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodValueToDataValueOverloaded. Converts val to an object of type returned by owner's GetDataType method. If it can not convert, it returns null. It makes use of any format provided and format string off the owner.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodAdjustSizeForOwnerBordersAdjusts the specified Size to account for the owner-specified borders  
Protected MethodAdjustSizeForOwnerPaddingAdjusts (increases) the specified size for the owner padding.  
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoCloseUpCloses the dropdown.  
Protected MethodDoDropDownDrops down the dropdown.  
Protected MethodGetAutoConvertedDestinationValueOverride this in specific editor to provide automatic conversions for that editor.  
Protected MethodGetDisplayValueOverride this in specific editor to provide display value.  
Protected MethodGetEditorValueOverride this in specific editor to provide editor value.  
Protected MethodGetInkProviderGets the InkProvider registered for the owner's container.  
Protected MethodGetTextSizeOfValueReturns the size required to render the editor's value for the specified owner and ownerContext.  
Protected MethodHookOwnersKeyEventsStart listening to the owner's key events  
Protected MethodInitializeFromInitializes the state of this object from a source object of the same type  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodIsDestinationValueValidOverride this in specific editor to check if converted value is valid. Note, this value does not use the ValueConstraint object returned by the owner's GetConstraints method during validation.  
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAfterCloseUpCalled after the dropdown has been closed up.  
Protected MethodOnAfterDropDownCalled after the dropdown has been dropped down.  
Protected MethodOnAfterEnterEditModeCalled after edit mode has been entered.  
Protected MethodOnAfterExitEditModeCalled after edit mode has been exited.  
Protected MethodOnBeforeDropDownCalled before the dropdown has been dropped down.  
Protected MethodOnBeforeEnterEditModeCalled before edit mode has been entered.  
Protected MethodOnBeforeExitEditModeCalled before edit mode has been exited.  
Protected MethodOnDisposeOverridden. Called when the editor is disposed  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnOwnerKeyDownOccurs when the owner gets a key down while in edit mode.  
Protected MethodOnOwnerKeyPressOccurs when the owner gets a key press while in edit mode.  
Protected MethodOnOwnerKeyUpOccurs when the owner gets a key up while in edit mode.  
Protected MethodOnSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodUnhookOwnersKeyEventsUnhook from the owner's key events  
Public Events
 NameDescription
Public EventAfterCloseUpOccurs after closing up the dropdown.  
Public EventAfterDropDownOccurs after dropping down the dropdown.  
Public EventAfterEnterEditModeOccurs after entering edit mode.  
Public EventAfterExitEditModeOccurs after exiting edit mode.  
Public EventBeforeDropDownOccurs before dropping down the dropdown.  
Public EventBeforeEnterEditModeOccurs before entering edit mode.  
Public EventBeforeExitEditModeOccurs before exiting edit mode.  
Public EventKeyDownOccurs on a key down while the editor is in edit mode and the editor has focus.  
Public EventKeyPressOccurs on a key press while the editor is in edit mode and the editor has focus.  
Public EventKeyUpOccurs on a key up while the editor is in edit mode and the editor has focus.  
Public EventSelectionChangedOccurs when a new value is selected from the dropdown.  
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventValueChangedOccurs when the value is changed in edit mode.  
See Also

Reference

EmbeddableEditorBase Class
Infragistics.Win Namespace
Infragistics.Shared.SubObjectBase