DiagramControl.ShowingOpenImageDialog Event
Fires before showing an ‘Insert Picture’ dialog, and allows it to be customized.
Namespace: DevExpress.Xpf.Diagram
Assembly: DevExpress.Xpf.Diagram.v24.1.dll
NuGet Package: DevExpress.Wpf.Diagram
Declaration
Event Data
The ShowingOpenImageDialog event's data class is DiagramShowingOpenImageDialogEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Cancel | Gets or sets whether the event should be canceled. Inherited from CancelRoutedEventArgs. |
| Filter | Gets or sets the string that determines the file filtering options that appear in the dialog. |
| Handled | Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs. |
| ImageSourceToOpen | Gets or sets the object from which to load the image skipping the dialog window. This object can be a full file path, Uri object, stream or array of bytes. |
| InitialDirectory | Gets or sets the path to the directory displayed by the dialog. |
| OriginalSource | Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs. |
| RoutedEvent | Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs. |
| Source | Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs. |
| Title | Gets or sets the title of the dialog. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| InvokeEventHandler(Delegate, Object) | When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs. |
| OnSetSource(Object) | When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs. |
Remarks
This event allows you to respond to an ‘Insert Picture’ dialog being invoked. You can handle it to change the dialog or prevent it from being displayed. To prevent the dialog from being displayed, set the event’s Cancel parameter to true.
You can also use the following event’s options:
- ImageSourceToOpen - allows you to specify the object that contains the image.
- Filter - allows you to specify the current file name filter string which determines the files that are displayed by the dialog box.
- InitialDirectory - allows you to specify the initial directory displayed by the dialog box.
- Title - allows you to specify the dialog box title.