MarketDepthControl
The visual control displaying the order book with quotes (IOrderBookMessage).
Inherits: BaseGridControl
Implements: IComponentConnector
Constructors
public MarketDepthControl()marketDepthControl = MarketDepthControl()Initializes a new instance of the MarketDepthControl.
Properties
public bool AllowOwnOrderDragDrop { get; set; }value = marketDepthControl.AllowOwnOrderDragDrop
marketDepthControl.AllowOwnOrderDragDrop = valueAllow own orders drag and drop.
public bool AllowSpreadToMove { get; set; }value = marketDepthControl.AllowSpreadToMove
marketDepthControl.AllowSpreadToMove = valueGets or sets a value indicating whether the spread is allowed to move. When , the spread can move up and down. When , the spread stays in the middle.
public TimeSpan AnimationDuration { get; set; }value = marketDepthControl.AnimationDuration
marketDepthControl.AnimationDuration = valueAnimation duration.
public bool AutoUpdateFormat { get; set; }value = marketDepthControl.AutoUpdateFormat
marketDepthControl.AutoUpdateFormat = valueAutomatically update format by Security). By default is on.
public Color CancelAnimationColor { get; set; }value = marketDepthControl.CancelAnimationColor
marketDepthControl.CancelAnimationColor = valueCancel animation color.
public IOrderBookMessage DepthData { get; set; }value = marketDepthControl.DepthData
marketDepthControl.DepthData = valueDepth data for binding. Setting this property updates the order book display.
public Security DepthSecurity { get; set; }value = marketDepthControl.DepthSecurity
marketDepthControl.DepthSecurity = valueSecurity for depth data binding.
public Color ErrorAnimationColor { get; set; }value = marketDepthControl.ErrorAnimationColor
marketDepthControl.ErrorAnimationColor = valueError animation color.
public Color FillBuyAnimationColor { get; set; }value = marketDepthControl.FillBuyAnimationColor
marketDepthControl.FillBuyAnimationColor = valueFill buy animation color.
public Color FillSellAnimationColor { get; set; }value = marketDepthControl.FillSellAnimationColor
marketDepthControl.FillSellAnimationColor = valueFill sell animation color.
public Color FillTextAnimationColor { get; set; }value = marketDepthControl.FillTextAnimationColor
marketDepthControl.FillTextAnimationColor = valueFill text color.
public decimal? GroupRange { get; set; }value = marketDepthControl.GroupRange
marketDepthControl.GroupRange = valueRange for Decimal).
public bool IsBidsOnTop { get; set; }value = marketDepthControl.IsBidsOnTop
marketDepthControl.IsBidsOnTop = valueWhether to show the bids above. The default is off.
public bool IsOwnOrderDragging { get; private set; }value = marketDepthControl.IsOwnOrderDragging
marketDepthControl.IsOwnOrderDragging = valueTrue if user is dragging an order.
public decimal MaxBuyVolume { get; set; }value = marketDepthControl.MaxBuyVolume
marketDepthControl.MaxBuyVolume = valueThe maximum volume of all bids.
public int MaxDepth { get; set; }value = marketDepthControl.MaxDepth
marketDepthControl.MaxDepth = valueThe maximum depth of order book display. The default value is DefaultDepth.
public decimal MaxSellVolume { get; set; }value = marketDepthControl.MaxSellVolume
marketDepthControl.MaxSellVolume = valueThe maximum volume of all asks.
public decimal MaxVolume { get; set; }value = marketDepthControl.MaxVolume
marketDepthControl.MaxVolume = valueThe maximum volume of all quotes.
public string PriceTextFormat { get; set; }value = marketDepthControl.PriceTextFormat
marketDepthControl.PriceTextFormat = valuePrice format.
public Color RegisterAnimationColor { get; set; }value = marketDepthControl.RegisterAnimationColor
marketDepthControl.RegisterAnimationColor = valueRegister animation color.
public MarketDepthExecuteOn RegisterOrderOn { get; set; }value = marketDepthControl.RegisterOrderOn
marketDepthControl.RegisterOrderOn = valueExecute order register trigger.
public QuoteChange? SelectedQuote { get; }value = marketDepthControl.SelectedQuoteThe selected quote.
public bool ShowBoardColumn { get; set; }value = marketDepthControl.ShowBoardColumn
marketDepthControl.ShowBoardColumn = valueShow Board column.
public bool ShowOwnVolumeColumns { get; set; }value = marketDepthControl.ShowOwnVolumeColumns
marketDepthControl.ShowOwnVolumeColumns = valueShow own volume columns.
public bool ShowSingleVolumeColumn { get; set; }value = marketDepthControl.ShowSingleVolumeColumn
marketDepthControl.ShowSingleVolumeColumn = valueShow single Volume column. The default value is .
public decimal? SparseRange { get; set; }value = marketDepthControl.SparseRange
marketDepthControl.SparseRange = valueRange for Int32).
public bool UseOrderAnimations { get; set; }value = marketDepthControl.UseOrderAnimations
marketDepthControl.UseOrderAnimations = valueUser own order state animations.
public string VolumeTextFormat { get; set; }value = marketDepthControl.VolumeTextFormat
marketDepthControl.VolumeTextFormat = valueVolume format.
Methods
public void CancelOrders(Func<Order, bool> predicate)marketDepthControl.CancelOrders(predicate)Cancel orders that were added to this instance of MarketDepthControl. This method does not cancel orders by itself. It just notifies subscribers with CancelingOrder event.
public MarketDepthColumns GetColumnIndex(GridColumn column)result = marketDepthControl.GetColumnIndex(column)To get the column type by cell.
- column
- Column.
Returns: The column type.
public IEnumerable<Order> GetOrders(decimal price, Sides? side, OrderTypes? type)result = marketDepthControl.GetOrders(price, side, type)Get active orders by specified criteria.
- price
- Order price.
- side
- Order side (buy or sell).
- type
- Order type.
Returns: Found orders.
public void InitializeComponent()marketDepthControl.InitializeComponent()InitializeComponent
protected override void OnLostMouseCapture(MouseEventArgs e)marketDepthControl.OnLostMouseCapture(e)Handle the event when mouse capture is lost.
- e
protected override void OnPreviewKeyDown(KeyEventArgs e)marketDepthControl.OnPreviewKeyDown(e)public void ProcessOrder(Order order, decimal price, decimal balance, OrderStates state)marketDepthControl.ProcessOrder(order, price, balance, state)To handle an order.
- order
- Order.
- price
- Order price.
- balance
- Order contracts balance.
- state
- Order state.
public void ProcessOrderFail(OrderFail fail, OrderStates state)marketDepthControl.ProcessOrderFail(fail, state)To handle an order register/move/cancel fail.
public void ShowOrderFill(Sides side, decimal price, decimal volume)marketDepthControl.ShowOrderFill(side, price, volume)Show order fill animation.
public void UpdateDepth(IOrderBookMessage message, Security security)marketDepthControl.UpdateDepth(message, security)To update the order book.
- message
- Market depth.
- security
- Security.
public void UpdateFormat(Security security)marketDepthControl.UpdateFormat(security)To update PriceTextFormat and VolumeTextFormat.
- security
- Security.
Events
public event Action<Order> CancelingOrdermarketDepthControl.CancelingOrder += handlerCanceling order.
public event Action<Order, decimal> MovingOrdermarketDepthControl.MovingOrder += handlerMoving order to new price.
public event Action<Sides, decimal> RegisteringOrdermarketDepthControl.RegisteringOrder += handlerRegistering order.
public event Action<QuoteChange?> SelectedQuoteChangedmarketDepthControl.SelectedQuoteChanged += handlerSelectedQuote changed event.
Fields
public static readonly DependencyProperty AllowOwnOrderDragDropPropertyvalue = MarketDepthControl.AllowOwnOrderDragDropPropertyDependencyProperty for AllowOwnOrderDragDrop.
public static readonly DependencyProperty AllowSpreadToMovePropertyvalue = MarketDepthControl.AllowSpreadToMovePropertyDependencyProperty for AllowSpreadToMove.
public static readonly DependencyProperty AnimationDurationPropertyvalue = MarketDepthControl.AnimationDurationPropertyAnimation duration.
public static readonly DependencyProperty CancelAnimationColorPropertyvalue = MarketDepthControl.CancelAnimationColorPropertyCancel animation color.
public const int DefaultDepthvalue = MarketDepthControl.DefaultDepthThe maximum depth by default which is equal to 20.
public static readonly DependencyProperty DepthDataPropertyvalue = MarketDepthControl.DepthDataPropertyDependencyProperty for DepthData.
public static readonly DependencyProperty DepthSecurityPropertyvalue = MarketDepthControl.DepthSecurityPropertyDependencyProperty for DepthSecurity.
public static readonly DependencyProperty ErrorAnimationColorPropertyvalue = MarketDepthControl.ErrorAnimationColorPropertyError animation color.
public static readonly DependencyProperty FillBuyAnimationColorPropertyvalue = MarketDepthControl.FillBuyAnimationColorPropertyFill buy animation color.
public static readonly DependencyProperty FillSellAnimationColorPropertyvalue = MarketDepthControl.FillSellAnimationColorPropertyFill sell animation color.
public static readonly DependencyProperty FillTextAnimationColorPropertyvalue = MarketDepthControl.FillTextAnimationColorPropertyFill text color.
public static readonly RoutedCommand GroupCommandvalue = MarketDepthControl.GroupCommandThe command for group market depth.
public static readonly DependencyProperty GroupRangePropertyvalue = MarketDepthControl.GroupRangePropertyDependencyProperty for GroupRange.
public static readonly RoutedCommand GroupResetCommandvalue = MarketDepthControl.GroupResetCommandThe command for reset grouping market depth.
public static readonly DependencyProperty IsBidsOnTopPropertyvalue = MarketDepthControl.IsBidsOnTopPropertyDependencyProperty for IsBidsOnTop.
public static readonly DependencyPropertyKey IsOwnOrderDraggingKeyvalue = MarketDepthControl.IsOwnOrderDraggingKeyTrue if user is dragging an order.
public static readonly DependencyProperty MaxBuyVolumePropertyvalue = MarketDepthControl.MaxBuyVolumePropertyDependencyProperty for MaxBuyVolume.
public static readonly DependencyProperty MaxDepthPropertyvalue = MarketDepthControl.MaxDepthPropertyDependencyProperty for MaxDepth.
public static readonly DependencyProperty MaxSellVolumePropertyvalue = MarketDepthControl.MaxSellVolumePropertyDependencyProperty for MaxSellVolume.
public static readonly DependencyProperty MaxVolumePropertyvalue = MarketDepthControl.MaxVolumePropertyDependencyProperty for MaxVolume.
public static readonly DependencyProperty PriceTextFormatPropertyvalue = MarketDepthControl.PriceTextFormatPropertyDependencyProperty for PriceTextFormat.
public static readonly DependencyProperty RegisterAnimationColorPropertyvalue = MarketDepthControl.RegisterAnimationColorPropertyRegister animation color.
public static readonly DependencyProperty RegisterOrderOnPropertyvalue = MarketDepthControl.RegisterOrderOnPropertyExecute order register trigger.
public static readonly DependencyProperty ShowBoardColumnPropertyvalue = MarketDepthControl.ShowBoardColumnPropertyDependencyProperty for ShowBoardColumn.
public static readonly DependencyProperty ShowOwnVolumeColumnsPropertyvalue = MarketDepthControl.ShowOwnVolumeColumnsPropertyDependencyProperty for ShowOwnVolumeColumns.
public static readonly DependencyProperty ShowSingleVolumeColumnPropertyvalue = MarketDepthControl.ShowSingleVolumeColumnPropertyDependencyProperty for ShowSingleVolumeColumn.
public static readonly RoutedCommand SparseCommandvalue = MarketDepthControl.SparseCommandThe command for sparse market depth.
public static readonly DependencyProperty SparseRangePropertyvalue = MarketDepthControl.SparseRangePropertyDependencyProperty for SparseRange.
public static readonly RoutedCommand SparseResetCommandvalue = MarketDepthControl.SparseResetCommandThe command for reset sparsing market depth.
public static readonly DependencyProperty UseOrderAnimationsPropertyvalue = MarketDepthControl.UseOrderAnimationsPropertyDependencyProperty for UseOrderAnimations.
public static readonly DependencyProperty VolumeTextFormatPropertyvalue = MarketDepthControl.VolumeTextFormatPropertyDependencyProperty for VolumeTextFormat.