RepositoryItemPictureEdit Members
Represents a repository item which stores settings specific to a PictureEdit control.Constructors
| Name | Description |
|---|---|
| RepositoryItemPictureEdit() | Initializes a new RepositoryItemPictureEdit class instance with default settings. |
Fields
| Name | Description |
|---|---|
| SuppressByteArrayToImageConversionWarning static | Obsolete. This field is obsolete (the control no longer detects if in-place image editors are bound to large byte arrays, and does not show related warnings. Note that operations with “byte[]” images can consume a significant amount of resources and may lead to a severe performance penalty). |
| SuppressDisposedImageWarning static | Obsolete. This API is obsolete now. |
Properties
| Name | Description |
|---|---|
| AccessibleDefaultActionDescription | Gets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from RepositoryItem. |
| AllowAnimationOnValueChanged | Gets or sets whether the pictures being edited are changed using animation. This property is not in effect for in-place editors. |
| AllowDisposeImage | Gets or sets whether to dispose of the PictureEdit control’s image when the control is disposed of. |
| AllowFocused | Gets or sets a value specifying whether a focus rectangle is displayed within the focused picture editor. |
| AllowFocusedAppearance | Gets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem. |
| AllowHtmlDraw | Gets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem. |
| AllowInplaceAutoFilter | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| AllowInplaceBorderPainter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowMouseWheel | Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItem. |
| AllowScrollOnMouseWheel | Gets or sets whether it is allowed to scroll pictures using the mouse wheel. |
| AllowScrollViaMouseDrag | Gets or sets whether an image can be scrolled by dragging it with the mouse. This feature is in effect when scroll bars are enabled via the RepositoryItemPictureEdit.ShowScrollBars property. |
| AllowZoom | Gets or sets whether users can use the mouse wheel and touch gestures to zoom pictures. |
| AllowZoomOnMouseWheel | Gets or sets whether it is allowed to zoom pictures using the mouse wheel. |
| AnimatedImageLoopMode | |
| Appearance | Gets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem. |
| AppearanceDisabled | Gets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem. |
| AppearanceFocused | Gets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem. |
| AppearanceReadOnly | Gets appearance settings used to paint the read-only editor. Inherited from RepositoryItem. |
| AutoHeight | Gets a value indicating whether the auto height feature is enabled. |
| BestFitWidth | Gets or sets the editor’s best fit width. Inherited from RepositoryItem. |
| BorderStyle | Gets or sets the editor’s border style. Inherited from RepositoryItem. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Caption | Gets or sets the caption displayed in the control and settings used to paint the caption. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContextButtonOptions | Provides access to the settings applied to the context buttons displayed in the PictureEdit control, and panels containing these buttons. |
| ContextButtons | Provides access to the collection of context buttons displayed in the PictureEdit control. |
| ContextMenu | Gets or sets the context menu for the editor. Inherited from RepositoryItem. |
| CustomHeight | Gets or sets the height of the picture editor when it works as an inplace control. |
| DefaultAlignment | Gets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem. |
| DefaultBorderStyleInBars | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DefaultBorderStyleInGrid | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayFormat | Gets format settings applied to the editor’s value. Inherited from RepositoryItem. |
| Editable | Gets whether the editor’s value can be changed. Inherited from RepositoryItem. |
| EditFormat | Provides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem. |
| EditorTypeName | Gets the class name of an edit control corresponding to the current repository item. |
| EditValueChangedDelay | Gets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringDelay static | Gets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringMode | Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem. |
| Enabled | Gets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem. |
| EnableLODImages | Gets or sets whether the LOD (Level-of-detail) algorithm is used to optimize the display of large images. |
| ErrorImage | Gets or sets an image displayed when an error occurs during an asynchronous image load. |
| ErrorImageOptions | Provides access to properties that allow you to assign and customize an image displayed when an error occurs during an asynchronous image load. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| ExportMode | Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem. |
| HtmlImages | Gets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. Inherited from RepositoryItem. |
| InitialImage | Gets or sets an image displayed during an asynchronous image load. |
| InitialImageOptions | Provides access to properties that allow you to assign and customize an image displayed during an asynchronous image load. |
| IsDesignMode | Indicates whether the editor is currently in design mode. Inherited from RepositoryItem. |
| IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from RepositoryItem. |
| IsEditValueChangedEventPending | Gets whether the EditValueChanged event is postponed. Inherited from RepositoryItem. |
| IsFilterLookUp | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsLoading | Indicates whether the editor is being loaded. Inherited from RepositoryItem. |
| IsLockUpdate | Gets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem. |
| IsNonSortableEditor | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| LinkCount | Gets the number of objects connected to the current repository item. Inherited from RepositoryItem. |
| LookAndFeel | Provides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. Inherited from RepositoryItem. |
| Name | Gets or sets the repository item name. Inherited from RepositoryItem. |
| NormalizeDisplayText static | Set the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem. |
| NullText | Gets or sets the text that presents the editor’s null value (null, System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem. |
| OpenFileDialogFilter | Gets or sets a custom filter for the Open File dialog. |
| OpenFileDialogFilterIndex | Gets or sets the index of the filter currently selected in the Open File Dialog. See this property description for more information: FilterIndex. |
| OptionsEditDialog | Contains settings that customize the Image Editor dialog. |
| OptionsMask | Provides access to settings that enable masked mode and allow you to customize the masked mode behavior. |
| OwnerEdit | Gets the editor that owns the repository item. Inherited from RepositoryItem. |
| OwnerItem | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| Padding | Gets or sets the amount of space, in pixels, between the control’s borders and its content. |
| PictureAlignment | Gets or sets the alignment of the image within the picture editor. |
| PictureInterpolationMode | Gets or sets how an image is scaled. |
| PictureStoreMode | Gets or sets how the editor stores the image pasted via the editor’s context menu. |
| PopupOffset | Gets or sets the popup window’s location. Inherited from RepositoryItem. |
| Properties | Obsolete. Gets an object providing properties specific to a picture edit control. |
| ReadOnly | Gets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem. |
| RequireDisplayTextSorting | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| SaveFileDialogFilter | Gets or sets a custom filter for the Save File dialog. |
| SaveFileDialogFilterIndex | Gets or sets the index of the filter currently selected in the Save File Dialog. See this property description for more information: FilterIndex. |
| ShowCameraMenuItem | Gets or sets whether the context menu contains a command that allows an end user to take a picture from a webcam. |
| ShowEditMenuItem | Gets or sets whether the control’s context menu contains the Edit command that invokes the Image Editor. The Image Editor allows users to perform basic edit operations and then save the result back to the PictureEdit control. |
| ShowMenu | Gets or sets a value indicating whether the context menu is displayed when the picture editor is right-clicked. |
| ShowScrollBars | Gets or sets whether scroll bars that allow an end-user to scroll the image are enabled. |
| ShowZoomSubMenu | Gets or sets whether the picture editor’s context menu contains zoom-related commands. |
| Site | Gets or sets a ISite for the object. Inherited from RepositoryItem. |
| SizeMode | Gets or sets how the image changes size within the picture editor. |
| SvgImageBinaryStoreMode | |
| SvgImageColorizationMode | Gets or sets the colorization mode for the RepositoryItemPictureEdit object’s SVG image. |
| SvgImageSize | Gets or sets the required size of the vector image. |
| Tag | Gets or sets the data associated with the repository item. Inherited from RepositoryItem. |
| UseDisabledStatePainter | Gets or sets whether the PictureEdit is painted grayed out when it’s in the disabled state. |
| UseParentBackground | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| UseTextEditorForAutoFilter | Gets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem. |
| ZoomAcceleration | Gets or sets the factor that adjusts the default zoom speed via the mouse wheel. |
| ZoomAccelerationFactor | Gets or sets the factor that adjusts the default zoom speed via the mouse wheel. This property is obsolete. Use the RepositoryItemPictureEdit.ZoomAcceleration property instead. |
| ZoomingOperationMode | Gets or sets whether the CTRL modifier key should be pressed to zoom pictures with the mouse wheel. |
| ZoomPercent | Gets or sets the zoom percentage of the displayed image. |
Methods
| Name | Description |
|---|---|
| Assign(RepositoryItem) | Copies the settings of a specific repository item to the current one. |
| BeginInit() | Notifies the editor that the initialization has been started. Inherited from RepositoryItem. |
| BeginUpdate() | Locks the RepositoryItem object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from RepositoryItem. |
| CancelUpdate() | Unlocks the RepositoryItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from RepositoryItem. |
| Clone() | Creates a copy of the current repository item. Inherited from RepositoryItem. |
| Connect(Object) | Connects the repository item to the specified object. Inherited from RepositoryItem. |
| CreateEditor() | Creates an editor whose type corresponds to the repository item’s type. Inherited from RepositoryItem. |
| CreateGroupPainter() | Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. Inherited from RepositoryItem. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| CreatePainter() | This member supports the editor library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| CreateViewInfo() | This member supports the editors library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| Disconnect(Object) | Removes the connection between the repository item and the specified object. Inherited from RepositoryItem. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndInit() | Notifies the editor that the initialization has been completed. Inherited from RepositoryItem. |
| EndUpdate() | Unlocks the RepositoryItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from RepositoryItem. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetBorderSides(Boolean, Boolean) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetBrick(PrintCellHelperInfo) | Returns a brick object that contains information on how the current editor should be printed. |
| GetDisplayText(FormatInfo, Object) | Returns the text representation of the specified value, formatted according to the specified settings. Inherited from RepositoryItem. |
| GetDisplayText(Object) | Returns the text representation of the specified value formatted using the editor’s settings. Inherited from RepositoryItem. |
| GetEditorType() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetEditValueForExportByOptions(Object, Object, Object, Object, Function3<String, Object, Object, Object>, ExportTarget) | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetHashCode() | Returns a hash code. Inherited from RepositoryItem. |
| GetImageLayoutMode() | Returns how the picture is aligned in the PictureEdit control. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNormalizedText(String) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| IsActivateKey(Keys) | Indicates whether a particular key can activate the editor used as an inplace control. Inherited from RepositoryItem. |
| IsLockDefaultImmediateUpdateRowPosition() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsNeededKey(Keys) | Indicates whether the key is handled by the editor or the container control. Inherited from RepositoryItem. |
| LockEvents() | This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetEvents() | This member supports the .NET Framework infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| ScaleProperties(ScaleHelper) | Updates the RepositoryItem according to current scale settings. This method is called automatically when the form’s runtime DPI settings differ from those in design-time. Inherited from RepositoryItem. |
| SwitchMode() | For internal use. Inherited from RepositoryItem. |
| ToString() | Returns a string that represents the current object. Inherited from RepositoryItem. |
| UnLockEvents() | This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
Events
| Name | Description |
|---|---|
| Click | Fires when clicking the editor. Inherited from RepositoryItem. |
| ContextButtonClick | Fires when a context button is clicked. |
| ContextButtonValueChanged | Fires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes. |
| CustomContextButtonToolTip | Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for RatingContextButton and TrackBarContextButton objects. |
| CustomDisplayText | Enables custom display text to be provided for an editor. Inherited from RepositoryItem. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DoubleClick | Fires when the editor is double clicked. Inherited from RepositoryItem. |
| DragDrop | Fires when an object is dropped onto the editor. Inherited from RepositoryItem. |
| DragEnter | Fires when a dragged object enters the editor’s area. Inherited from RepositoryItem. |
| DragLeave | Fires when a dragged object leaves the editor’s area. Inherited from RepositoryItem. |
| DragOver | Fires repeatedly when dragging an object over the editor. Inherited from RepositoryItem. |
| EditValueChanged | Fires when the editor’s EditValue property changes. Inherited from RepositoryItem. |
| EditValueChanging | Fires when the editor’s value is about to be changed. Inherited from RepositoryItem. |
| Enter | Fires when the editor receives focus. Inherited from RepositoryItem. |
| FormatEditValue | Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem. |
| GetResampledImage | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| GiveFeedback | Enables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem. |
| HelpRequested | Fires when the end-user requests help for the editor. Inherited from RepositoryItem. |
| ImageChanged | Occurs after the value of the PictureEdit.Image property has been changed. |
| ImageEditorDialogClosed | Fires when the Image Editor dialog is closed. |
| ImageEditorDialogShowing | Fires when the Editor dialog is about to be opened. Allows you to customize the dialog and its graphic commands. |
| ImageLoading | Allows you to execute actions when a user loads a file via the control’s context menu. You can handle this event to perform image preprocessing or to load images stored in unsupported formats. |
| ImageSaving | Allows you to execute actions when a user saves the current image via the control’s context menu. You can handle this event to perform image preprocessing or to save the image to a custom image format. |
| KeyDown | Fires when a key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyPress | Fires when a character key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyUp | Fires when a key is released while the editor has focus. Inherited from RepositoryItem. |
| Leave | Fires when the editor loses focus. Inherited from RepositoryItem. |
| LoadCompleted | Fires when an asynchronous image load operation is completed, been canceled, or raised an exception. |
| Modified | Fires when the edit value is first changed since it was last validated. Inherited from RepositoryItem. |
| MouseDown | Fires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseEnter | Fires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem. |
| MouseHover | Fires when hot-tracking an editor element. Inherited from RepositoryItem. |
| MouseLeave | Fires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem. |
| MouseMove | Fires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem. |
| MouseUp | Fires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseWheel | Fires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem. |
| ParseEditValue | Converts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem. |
| PopupMenuShowing | Fires when the context menu is about to be displayed. |
| PropertiesChanged | Fires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem. |
| QueryAccessibilityHelp | Fires when the help is provided to accessibility applications. Inherited from RepositoryItem. |
| QueryContinueDrag | Fires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem. |
| QueryProcessKey | Provides the capability to specify whether the key pressed in the editor is processed by the editor or a container control (GridControl, TreeList, etc.) that displays this editor. Inherited from RepositoryItem. |
| TakePictureDialogClosed | Fires when the Take Picture dialog is closed. Allows you to get the dialog result and captured image, and replace this image. |
| TakePictureDialogShowing | Fires when the Take Picture dialog is about to be displayed. Allows you to customize the dialog, and specify the camera device and resolution. |
| Validating | Allows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled. Inherited from RepositoryItem. |
| ZoomPercentChanged | Fires when the RepositoryItemPictureEdit.ZoomPercent property is changed. |
See Also