All docs
V21.2
21.2
21.1
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

ASPxClientDiagram Members

A client-side equivalent of the ASPxDiagram control.

Properties

Name Description
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

Name Description
AdjustControl Modifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls static Modifies the controls size within the specified container. Inherited from ASPxClientControl.
Cast(obj) static Converts the specified object to the current object’s type. Inherited from ASPxClientControl.
Export Exports the diagram data in JSON format.
ExportTo(format, callback) Exports the diagram to an image format.
FitToContent Fits the diagram content into the work area. The maximum scale is 100%.
FitToWidth Fits the diagram content’s width into the work area width. The maximum scale is 100%.
Focus Focuses the Diagram control.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection static Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetHeight Returns the control’s height. Inherited from ASPxClientControl.
GetItemById(id) Returns a shape or connector object specified by its internal identifier.
GetItemByKey(key) Returns a shape or connector object specified by its key.
GetItems Returns an array of diagram items.
GetMainElement Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControl Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetReadOnly Returns a value that indicates whether the control’s status is read-only.
GetSelectedItems Returns an array of selected diagram items.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
Import(data) Imports the diagram data.
InCallback Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
ScrollToItem(item) Scrolls the view area to the specified item.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetFullscreenMode(fullscreen) Allows you to enable/disable full-screen mode.
SetHeight(height)

Specifies the control’s height. Note that this method is not in effect for some controls.

Inherited from ASPxClientControl.
SetReadOnly(readOnly) Allows you to enable/disable read-only mode.
SetSelectedItems(items) Selects the specified items.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control’s width in pixels. Inherited from ASPxClientControl.
UpdateToolbox

Events

Name Description
BeginCallback Occurs when a callback for server-side processing is initiated.
BeginSynchronization Fires after a diagram model’s data (mapped to a data source) is changed and the client-server synchronization starts to apply the change on the server.
CallbackError Fires on the client if any unhandled server error occurs during server-side processing of a callback sent by the ASPxClientDiagram.
CustomShapeCreateTemplate Allows you to create a template for custom shapes.
CustomShapeCreateToolboxTemplate Allows you to create a template for custom shapes in the toolbox.
DiagramChanged Fires when the diagram’s data is changed.
EndCallback Occurs on the client side after a callback’s server-side processing has been completed.
EndSynchronization Fires after a diagram model’s data change is applied to the server (the server and client document models have been synchronized).
Init Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
ItemClick Fires after a shape or connector is clicked.
ItemDblClick Fires after a shape or connector is double-clicked.
RequestEditOperation Allows you to prohibit an edit operation at run time.
SelectionChanged Fires after the selection changes in the Diagram.
See Also