Version

OptionSetEditor Class Members

The following tables list the members exposed by OptionSetEditor.

Public Constructors
 NameDescription
Public ConstructorOptionSetEditor ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyCanFocusOverridden. Determines if item can recieve focus  
Public PropertyCurrentEditTextOverridden. Returns 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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDefaultOwnerReturns the default embeddable editor owner, which may provide default owner-specific values for an editor (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorSharedObjectNameSpecifies name of the shared object that was defined for this editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyElementBeingEditedReturns the embeddable element that is currently in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyFocusedOverridden. Determines if editor has focus  
Public PropertyFocusedIndexSets/Gets the focused index  
Public PropertyHorizontalItemSpacingControls the horizontal spacing between item columns  
Public PropertyIsDroppedDownReturns true if in edit mode and dropped down (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsInEditModeReturns true if the editor is in edit mode (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsValidOverridden. Determines if value is valid  
Public PropertyItemOriginDetermines the origin of the option buttons relative to the top/left of the control.  
Public PropertyMaxColumnWidthDetermines the largest possible width that a column of items can have.  
Public PropertyMinColumnWidthDetermines the smallest possible width of a columns of items.  
Public PropertySelectedTextGets or sets the currently selected text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectionLengthGets or sets the number of characters selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectionStartGets or sets the starting point of text selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsAutoSizeEditSpecifies whether the editor supports AutoSizeEdit (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsDropDownReturns true if this editor supports a dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsSelectableTextReturns true if this editor supports selecting text. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsSpellCheckingReturns true if this editor supports spell checking. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsValueListOverridden. Specifies whether the editor supports value list (read-only).  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextIndentationControls the space between the option button and the text.  
Public PropertyTextLengthGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyValueOverridden. Returns the Selected item  
Public PropertyVerticalItemSpacingControls the vertical spacing between item columns  
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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectedTextInternalGets or sets the currently selected text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectionLengthInternalGets or sets the number of characters selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySelectionStartInternalGets or sets the starting point of text selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Protected PropertyTextLengthInternalGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected PropertyWantsOwnerKeyEventsOverridden. WantsOwnerKeyEvents  
Public Methods
 NameDescription
Public MethodApplyValueAppearanceApplies any appearance associated with the dataVal data value. Base implementation does nothing. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCanEditTypeOverridden. used to determine if type can be edited  
Public MethodCanRenderTypeOverridden. Used to determine if type can be edited  
Public MethodCloneOverridden. Creates a copy of the embeddable editor with the specified default owner.  
Public MethodCloseUpCalled to have the dropdown close up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodComparesByValueReturns whether the owner should compare items based on their underlying value rather than their display text. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCreateAccessibilityInstanceOverridden. Used 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 MethodCreateUIAutomationProviderOverridden. Used 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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownCalled to drop down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodEnterEditModeCalled to place the editor in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodExitEditModeCalled to have the editor exit edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodFocusOverridden. Called when focus is set to the control  
Public MethodGetDropDownStateReturns information about whether the dropdown is dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEditStatusReturns information about whether the object is in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEmbeddableElementOverloaded. Overridden. Called from inside the UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements.  
Public MethodGetEmbeddableElementTypeOverridden. Returns 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. Overridden. Used to determine the size preferred/required by the editor.  
Public MethodGetSpellCheckTargetGets the current spell check target (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsInputKeyOverridden. Returns 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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
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). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodResetHorizontalItemSpacingHelper to reset the property  
Public MethodResetItemOriginHelper to reset the property  
Public MethodResetTextIndentationHelper to reset the property  
Public MethodResetVerticalItemSpacingHelper to reset the property  
Public MethodSelectAllSelects all text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodShouldSerializeHorizontalItemSpacingHelper used to determine if item should be serialized  
Public MethodShouldSerializeItemOriginHelper used to determine if item should be serialized  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodShouldSerializeTextIndentationHelper used to determine if item should be serialized  
Public MethodShouldSerializeVerticalItemSpacingHelper used to determine if item should be serialized  
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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodAdjustSizeForOwnerBordersAdjusts the specified Size to account for the owner-specified borders (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodAdjustSizeForOwnerPaddingAdjusts (increases) the specified size for the owner padding. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoCloseUpCloses the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDoDropDownDrops down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetAutoConvertedDestinationValueOverridden. Override this in specific editor to provide automatic conversions for that editor.  
Protected MethodGetDisplayValueOverride this in specific editor to provide display value. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetEditorValueOverridden. Override this in specific editor to provide editor value.  
Protected MethodGetInkProviderGets the InkProvider registered for the owner's container. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetTextSizeOfValueReturns the size required to render the editor's value for the specified owner and ownerContext. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodHookOwnersKeyEventsStart listening to the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodInitializeFromOverridden. Initializes 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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
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. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterDropDownCalled after the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterEnterEditModeOverridden. OnAfterEnterEditMode  
Protected MethodOnAfterExitEditModeOverridden. Called after edit mode has been exited  
Protected MethodOnBeforeDropDownCalled before the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeEnterEditModeOverridden. Invoked before the OptionSetEditor enters edit mode.  
Protected MethodOnBeforeExitEditModeOverridden. Invoked before the OptionSetEditor exits edit mode.  
Protected MethodOnDisposeCalled when the editor is disposed (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnOwnerKeyDownOverridden. OnOwnerKeyDown  
Protected MethodOnOwnerKeyPressOccurs when the owner gets a key press while in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnOwnerKeyUpOccurs when the owner gets a key up while in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
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 (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Events
 NameDescription
Public EventAfterCloseUpOccurs after closing up the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterDropDownOccurs after dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterEnterEditModeOccurs after entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterExitEditModeOccurs after exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeDropDownOccurs before dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeEnterEditModeOccurs before entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeExitEditModeOccurs before exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyDownOccurs on a key down while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyPressOccurs on a key press while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyUpOccurs on a key up while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSelectionChangedOccurs when a new value is selected from the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventValueChangedOccurs when the value is changed in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
See Also