Back to Devexpress

RepositoryItemPictureEdit Members

windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitempictureedit-dot-underscore-members.md

latest53.4 KB
Original Source

RepositoryItemPictureEdit Members

Represents a repository item which stores settings specific to a PictureEdit control.

Constructors

NameDescription
RepositoryItemPictureEdit()Initializes a new RepositoryItemPictureEdit class instance with default settings.

Fields

NameDescription
SuppressByteArrayToImageConversionWarning staticObsolete. 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 staticObsolete. This API is obsolete now.

Properties

NameDescription
AccessibleDefaultActionDescriptionGets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem.
AccessibleRoleGets or sets the object’s accessible role. Inherited from RepositoryItem.
AllowAnimationOnValueChangedGets or sets whether the pictures being edited are changed using animation. This property is not in effect for in-place editors.
AllowDisposeImageGets or sets whether to dispose of the PictureEdit control’s image when the control is disposed of.
AllowFocusedGets or sets a value specifying whether a focus rectangle is displayed within the focused picture editor.
AllowFocusedAppearanceGets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem.
AllowHtmlDrawGets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem.
AllowInplaceAutoFilterThis member supports the internal infrastructure, and is not intended to be used directly from your code.
AllowInplaceBorderPainterThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
AllowMouseWheelGets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItem.
AllowScrollOnMouseWheelGets or sets whether it is allowed to scroll pictures using the mouse wheel.
AllowScrollViaMouseDragGets 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.
AllowZoomGets or sets whether users can use the mouse wheel and touch gestures to zoom pictures.
AllowZoomOnMouseWheelGets or sets whether it is allowed to zoom pictures using the mouse wheel.
AnimatedImageLoopMode
AppearanceGets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem.
AppearanceDisabledGets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem.
AppearanceFocusedGets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem.
AppearanceReadOnlyGets appearance settings used to paint the read-only editor. Inherited from RepositoryItem.
AutoHeightGets a value indicating whether the auto height feature is enabled.
BestFitWidthGets or sets the editor’s best fit width. Inherited from RepositoryItem.
BorderStyleGets or sets the editor’s border style. Inherited from RepositoryItem.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionGets or sets the caption displayed in the control and settings used to paint the caption.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContextButtonOptionsProvides access to the settings applied to the context buttons displayed in the PictureEdit control, and panels containing these buttons.
ContextButtonsProvides access to the collection of context buttons displayed in the PictureEdit control.
ContextMenuGets or sets the context menu for the editor. Inherited from RepositoryItem.
CustomHeightGets or sets the height of the picture editor when it works as an inplace control.
DefaultAlignmentGets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem.
DefaultBorderStyleInBarsThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DefaultBorderStyleInGridThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFormatGets format settings applied to the editor’s value. Inherited from RepositoryItem.
EditableGets whether the editor’s value can be changed. Inherited from RepositoryItem.
EditFormatProvides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem.
EditorTypeNameGets the class name of an edit control corresponding to the current repository item.
EditValueChangedDelayGets 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 staticGets 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.
EditValueChangedFiringModeGets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem.
EnabledGets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem.
EnableLODImagesGets or sets whether the LOD (Level-of-detail) algorithm is used to optimize the display of large images.
ErrorImageGets or sets an image displayed when an error occurs during an asynchronous image load. This property is obsolete. Use the ErrorImageOptions property instead.
ErrorImageOptionsProvides access to properties that allow you to assign and customize an image displayed when an error occurs during an asynchronous image load.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExportModeSpecifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem.
HtmlImagesGets 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.
InitialImageGets or sets an image displayed during an asynchronous image load. This property is obsolete. Use the InitialImageOptions property instead.
InitialImageOptionsProvides access to properties that allow you to assign and customize an image displayed during an asynchronous image load.
InplaceModeImmediatePostChangesFor internal use. Gets or sets whether the in-place editor posts its value to the bound data source immediately after the value changes. Inherited from RepositoryItem.
IsDesignModeIndicates whether the editor is currently in design mode. Inherited from RepositoryItem.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from RepositoryItem.
IsEditValueChangedEventPendingGets whether the EditValueChanged event is postponed. Inherited from RepositoryItem.
IsFilterLookUpThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
IsLoadingIndicates whether the editor is being loaded. Inherited from RepositoryItem.
IsLockUpdateGets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem.
IsNonSortableEditorThis member supports the internal infrastructure, and is not intended to be used directly from your code.
LinkCountGets the number of objects connected to the current repository item. Inherited from RepositoryItem.
LookAndFeelProvides 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.
NameGets or sets the repository item name. Inherited from RepositoryItem.
NormalizeDisplayText staticSet the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem.
NullTextGets or sets the text that presents the editor’s null value ( null , System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem.
OpenFileDialogFilterGets or sets a custom filter for the Open File dialog.
OpenFileDialogFilterIndexGets or sets the index of the filter currently selected in the Open File Dialog. See this property description for more information: FilterIndex.
OptionsEditDialogContains settings that customize the Image Editor dialog.
OptionsMaskProvides access to settings that enable masked mode and allow you to customize the masked mode behavior.
OwnerEditGets the editor that owns the repository item. Inherited from RepositoryItem.
OwnerItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
PaddingGets or sets the amount of space, in pixels, between the control’s borders and its content.
PictureAlignmentGets or sets the alignment of the image within the picture editor.
PictureInterpolationModeGets or sets how an image is scaled.
PictureStoreModeGets or sets how the editor stores the image pasted via the editor’s context menu.
PopupOffsetGets or sets the popup window’s location. Inherited from RepositoryItem.
PropertiesObsolete. Gets an object providing properties specific to a picture edit control.
ReadOnlyGets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem.
RequireDisplayTextSortingThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem.
SaveFileDialogFilterGets or sets a custom filter for the Save File dialog.
SaveFileDialogFilterIndexGets or sets the index of the filter currently selected in the Save File Dialog. See this property description for more information: FilterIndex.
ShowCameraMenuItemGets or sets whether the context menu contains a command that allows an end user to take a picture from a webcam.
ShowEditMenuItemGets 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.
ShowMenuGets or sets a value indicating whether the context menu is displayed when the picture editor is right-clicked.
ShowScrollBarsGets or sets whether scroll bars that allow an end-user to scroll the image are enabled.
ShowZoomSubMenuGets or sets whether the picture editor’s context menu contains zoom-related commands.
SiteGets or sets a ISite for the object. Inherited from RepositoryItem.
SizeModeGets or sets how the image changes size within the picture editor.
SvgImageBinaryStoreMode
SvgImageColorizationModeGets or sets the colorization mode for the RepositoryItemPictureEdit object’s SVG image.
SvgImageSizeGets or sets the required size of the vector image.
TagGets or sets the data associated with the repository item. Inherited from RepositoryItem.
UseDisabledStatePainterGets or sets whether the PictureEdit is painted grayed out when it’s in the disabled state.
UseParentBackgroundThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem.
ZoomAccelerationGets or sets the factor that adjusts the default zoom speed via the mouse wheel.
ZoomAccelerationFactorGets or sets the factor that adjusts the default zoom speed via the mouse wheel. This property is obsolete. Use the RepositoryItemPictureEdit.ZoomAcceleration property instead.
ZoomingOperationModeGets or sets whether the CTRL modifier key should be pressed to zoom pictures with the mouse wheel.
ZoomPercentGets or sets the zoom percentage of the displayed image.

Methods

NameDescription
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) staticDetermines 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) staticThis 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) staticThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
GetService(Type) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines 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

NameDescription
ClickFires when clicking the editor. Inherited from RepositoryItem.
ContextButtonClickFires when a context button is clicked.
ContextButtonValueChangedFires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes.
CustomContextButtonToolTipAllows 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.
CustomDisplayTextEnables custom display text to be provided for an editor. Inherited from RepositoryItem.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DoubleClickFires when the editor is double clicked. Inherited from RepositoryItem.
DragDropFires when an object is dropped onto the editor. Inherited from RepositoryItem.
DragEnterFires when a dragged object enters the editor’s area. Inherited from RepositoryItem.
DragLeaveFires when a dragged object leaves the editor’s area. Inherited from RepositoryItem.
DragOverFires repeatedly when dragging an object over the editor. Inherited from RepositoryItem.
EditValueChangedFires when the editor’s EditValue property changes. Inherited from RepositoryItem.
EditValueChangingFires when the editor’s value is about to be changed. Inherited from RepositoryItem.
EnterFires when the editor receives focus. Inherited from RepositoryItem.
FormatEditValueEnables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem.
GetResampledImageThis member supports the internal infrastructure, and is not intended to be used directly from your code.
GiveFeedbackEnables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem.
HelpRequestedFires when the end-user requests help for the editor. Inherited from RepositoryItem.
ImageChangedOccurs after the value of the PictureEdit.Image property has been changed.
ImageEditorDialogClosedFires when the Image Editor dialog is closed.
ImageEditorDialogShowingFires when the Editor dialog is about to be opened. Allows you to customize the dialog and its graphic commands.
ImageLoadingAllows 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.
ImageSavingAllows 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.
KeyDownFires when a key is pressed while the editor has focus. Inherited from RepositoryItem.
KeyPressFires when a character key is pressed while the editor has focus. Inherited from RepositoryItem.
KeyUpFires when a key is released while the editor has focus. Inherited from RepositoryItem.
LeaveFires when the editor loses focus. Inherited from RepositoryItem.
LoadCompletedFires when an asynchronous image load operation is completed, been canceled, or raised an exception.
ModifiedFires when the edit value is first changed since it was last validated. Inherited from RepositoryItem.
MouseDownFires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem.
MouseEnterFires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem.
MouseHoverFires when hot-tracking an editor element. Inherited from RepositoryItem.
MouseLeaveFires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem.
MouseMoveFires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem.
MouseUpFires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem.
MouseWheelFires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem.
ParseEditValueConverts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem.
PopupMenuShowingFires when the context menu is about to be displayed.
PropertiesChangedFires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem.
QueryAccessibilityHelpFires when the help is provided to accessibility applications. Inherited from RepositoryItem.
QueryContinueDragFires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem.
QueryProcessKeyProvides 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.
TakePictureDialogClosedFires when the Take Picture dialog is closed. Allows you to get the dialog result and captured image, and replace this image.
TakePictureDialogShowingFires when the Take Picture dialog is about to be displayed. Allows you to customize the dialog, and specify the camera device and resolution.
ValidatingAllows 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.
ZoomPercentChangedFires when the RepositoryItemPictureEdit.ZoomPercent property is changed.

See Also

RepositoryItemPictureEdit Class

DevExpress.XtraEditors.Repository Namespace