Back to Devexpress

ASPxClientDiagram Members

aspnet-js-aspxclientdiagram-dot-underscore-members.md

latest7.9 KB
Original Source

ASPxClientDiagram Members

A client-side equivalent of the ASPxDiagram control.

Properties

NameDescription
nameGets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

NameDescription
AdjustControlModifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls staticModifies the controls size within the specified container. Inherited from ASPxClientControl.
Cast(obj) staticConverts the specified object to the current object’s type. Inherited from ASPxClientControl.
ExportExports the diagram data in JSON format.
ExportTo(format, callback)Exports the diagram to an image format.
FitToContentFits the diagram content into the work area. The maximum scale is 100%.
FitToWidthFits the diagram content’s width into the work area width. The maximum scale is 100%.
FocusFocuses the Diagram control.
GetClientVisibleObsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection staticReturns a collection of client web control objects. Inherited from ASPxClientControl.
GetHeightReturns 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.
GetItemsReturns an array of diagram items.
GetMainElementReturns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControlReturns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetReadOnlyReturns a value that indicates whether the control’s status is read-only.
GetSelectedItemsReturns an array of selected diagram items.
GetVisibleReturns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidthReturns the control’s width. Inherited from ASPxClientControl.
Import(data)Imports the diagram data.
InCallbackReturns 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 | Updates the diagram toolboxes. |

Events

NameDescription
BeginCallbackOccurs when a callback for server-side processing is initiated.
BeginSynchronizationFires 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.
CallbackErrorFires on the client if any unhandled server error occurs during server-side processing of a callback sent by the ASPxClientDiagram.
CustomShapeCreateTemplateAllows you to create a template for custom shapes.
CustomShapeCreateToolboxTemplateAllows you to create a template for custom shapes in the toolbox.
DiagramChangedFires when the diagram’s data is changed.
EndCallbackOccurs on the client side after a callback’s server-side processing has been completed.
EndSynchronizationFires after a diagram model’s data change is applied to the server (the server and client document models have been synchronized).
InitOccurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
ItemClickFires after a shape or connector is clicked.
ItemDblClickFires after a shape or connector is double-clicked.
RequestEditOperationAllows you to prohibit an edit operation at run time.
SelectionChangedFires after the selection changes in the Diagram.

See Also

ASPxClientDiagram Class