Class MarketDepthControl
- Namespace
- StockSharp.Xaml
- Assembly
- StockSharp.Xaml.dll
The visual control displaying the order book with quotes (IOrderBookMessage).
public class MarketDepthControl : BaseGridControl, IPersistable, IComponentConnector- Inheritance
-
MarketDepthControl
- Implements
-
IPersistable
- Inherited Members
- Extension Methods
Constructors
MarketDepthControl()
Initializes a new instance of the MarketDepthControl.
public MarketDepthControl()Fields
AllowOwnOrderDragDropProperty
public static readonly DependencyProperty AllowOwnOrderDragDropPropertyField Value
AllowSpreadToMoveProperty
public static readonly DependencyProperty AllowSpreadToMovePropertyField Value
AnimationDurationProperty
Animation duration.
public static readonly DependencyProperty AnimationDurationPropertyField Value
CancelAnimationColorProperty
Cancel animation color.
public static readonly DependencyProperty CancelAnimationColorPropertyField Value
DefaultDepth
The maximum depth by default which is equal to 20.
public const int DefaultDepth = 20Field Value
ErrorAnimationColorProperty
Error animation color.
public static readonly DependencyProperty ErrorAnimationColorPropertyField Value
FillAnimationColorProperty
Fill animation color.
public static readonly DependencyProperty FillAnimationColorPropertyField Value
FillBuyAnimationColorProperty
Fill buy animation color.
public static readonly DependencyProperty FillBuyAnimationColorPropertyField Value
FillSellAnimationColorProperty
Fill sell animation color.
public static readonly DependencyProperty FillSellAnimationColorPropertyField Value
FillTextAnimationColorProperty
Fill text color.
public static readonly DependencyProperty FillTextAnimationColorPropertyField Value
GroupCommand
The command for group market depth.
public static readonly RoutedCommand GroupCommandField Value
GroupResetCommand
The command for reset grouping market depth.
public static readonly RoutedCommand GroupResetCommandField Value
IsBidsOnTopProperty
public static readonly DependencyProperty IsBidsOnTopPropertyField Value
IsOwnOrderDraggingKey
True if user is dragging an order.
public static readonly DependencyPropertyKey IsOwnOrderDraggingKeyField Value
MaxBuyVolumeProperty
public static readonly DependencyProperty MaxBuyVolumePropertyField Value
MaxDepthProperty
public static readonly DependencyProperty MaxDepthPropertyField Value
MaxSellVolumeProperty
public static readonly DependencyProperty MaxSellVolumePropertyField Value
MaxVolumeProperty
public static readonly DependencyProperty MaxVolumePropertyField Value
PriceTextFormatProperty
public static readonly DependencyProperty PriceTextFormatPropertyField Value
RegisterAnimationColorProperty
Register animation color.
public static readonly DependencyProperty RegisterAnimationColorPropertyField Value
RegisterOrderOnProperty
Execute order register trigger.
public static readonly DependencyProperty RegisterOrderOnPropertyField Value
ShowBoardColumnProperty
public static readonly DependencyProperty ShowBoardColumnPropertyField Value
ShowOwnVolumeColumnsProperty
public static readonly DependencyProperty ShowOwnVolumeColumnsPropertyField Value
ShowSingleVolumeColumnProperty
public static readonly DependencyProperty ShowSingleVolumeColumnPropertyField Value
SparseCommand
The command for sparse market depth.
public static readonly RoutedCommand SparseCommandField Value
SparseResetCommand
The command for reset sparsing market depth.
public static readonly RoutedCommand SparseResetCommandField Value
UseOrderAnimationsProperty
public static readonly DependencyProperty UseOrderAnimationsPropertyField Value
VolumeTextFormatProperty
public static readonly DependencyProperty VolumeTextFormatPropertyField Value
Properties
AllowOwnOrderDragDrop
Allow own orders drag and drop.
public bool AllowOwnOrderDragDrop { get; set; }Property Value
AllowSpreadToMove
Gets or sets a value indicating whether the spread is allowed to move. When true, the spread can move up and down. When false, the spread stays in the middle.
public bool AllowSpreadToMove { get; set; }Property Value
AnimationDuration
Animation duration.
public TimeSpan AnimationDuration { get; set; }Property Value
AutoUpdateFormat
Automatically update format by UpdateFormat(Security). By default is on.
public bool AutoUpdateFormat { get; set; }Property Value
CancelAnimationColor
Cancel animation color.
public Color CancelAnimationColor { get; set; }Property Value
ErrorAnimationColor
Error animation color.
public Color ErrorAnimationColor { get; set; }Property Value
FillAnimationColor
Fill animation color.
public Color FillAnimationColor { get; set; }Property Value
FillBuyAnimationColor
Fill buy animation color.
public Color FillBuyAnimationColor { get; set; }Property Value
FillSellAnimationColor
Fill sell animation color.
public Color FillSellAnimationColor { get; set; }Property Value
FillTextAnimationColor
Fill text color.
public Color FillTextAnimationColor { get; set; }Property Value
GroupRange
Range for Group(IOrderBookMessage, decimal).
public decimal? GroupRange { get; set; }Property Value
IsBidsOnTop
Whether to show the bids above. The default is off.
public bool IsBidsOnTop { get; set; }Property Value
IsOwnOrderDragging
True if user is dragging an order.
public bool IsOwnOrderDragging { get; }Property Value
MaxBuyVolume
The maximum volume of all bids.
public decimal MaxBuyVolume { get; set; }Property Value
MaxDepth
The maximum depth of order book display. The default value is DefaultDepth.
public int MaxDepth { get; set; }Property Value
MaxSellVolume
The maximum volume of all asks.
public decimal MaxSellVolume { get; set; }Property Value
MaxVolume
The maximum volume of all quotes.
public decimal MaxVolume { get; set; }Property Value
PriceTextFormat
Price format.
public string PriceTextFormat { get; set; }Property Value
RegisterAnimationColor
Register animation color.
public Color RegisterAnimationColor { get; set; }Property Value
RegisterOrderOn
Execute order register trigger.
public MarketDepthExecuteOn RegisterOrderOn { get; set; }Property Value
SelectedQuote
The selected quote.
public QuoteChange? SelectedQuote { get; }Property Value
ShowBoardColumn
Show Board column.
public bool ShowBoardColumn { get; set; }Property Value
ShowOwnVolumeColumns
Show own volume columns.
public bool ShowOwnVolumeColumns { get; set; }Property Value
ShowSingleVolumeColumn
public bool ShowSingleVolumeColumn { get; set; }Property Value
SparseRange
Range for Sparse(IOrderBookMessage, decimal, decimal?).
public decimal? SparseRange { get; set; }Property Value
UseOrderAnimations
User own order state animations.
public bool UseOrderAnimations { get; set; }Property Value
VolumeTextFormat
Volume format.
public string VolumeTextFormat { get; set; }Property Value
Methods
CancelOrders(Func<Order, bool>)
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 void CancelOrders(Func<Order, bool> predicate = null)Parameters
Clear()
To clear the order book.
public void Clear()GetColumnIndex(GridColumn)
To get the column type by cell.
public MarketDepthColumns GetColumnIndex(GridColumn column)Parameters
columnGridColumnColumn.
Returns
- MarketDepthColumns
The column type.
GetOrders(decimal, Sides?, OrderTypes?)
Get active orders by specified criteria.
public IEnumerable<Order> GetOrders(decimal price, Sides? side = null, OrderTypes? type = null)Parameters
pricedecimalOrder price.
sideSides?Order side (buy or sell).
typeOrderTypes?Order type.
Returns
- IEnumerable<Order>
Found orders.
InitializeComponent()
InitializeComponent
public void InitializeComponent()Load(SettingsStorage)
Load settings.
public override void Load(SettingsStorage storage)Parameters
storageSettingsStorageSettings storage.
OnLostMouseCapture(MouseEventArgs)
protected override void OnLostMouseCapture(MouseEventArgs e)Parameters
OnPreviewKeyDown(KeyEventArgs)
protected override void OnPreviewKeyDown(KeyEventArgs e)Parameters
ProcessOrder(Order, decimal, decimal, OrderStates)
To handle an order.
public void ProcessOrder(Order order, decimal price, decimal balance, OrderStates state)Parameters
orderOrderOrder.
pricedecimalOrder price.
balancedecimalOrder contracts balance.
stateOrderStatesOrder state.
ProcessOrderFail(OrderFail, OrderStates)
To handle an order register/move/cancel fail.
public void ProcessOrderFail(OrderFail fail, OrderStates state)Parameters
failOrderFailstateOrderStates
Save(SettingsStorage)
Save settings.
public override void Save(SettingsStorage storage)Parameters
storageSettingsStorageSettings storage.
ShowOrderFill(Sides, decimal, decimal)
Show order fill animation.
public void ShowOrderFill(Sides side, decimal price, decimal volume)Parameters
UpdateDepth(IOrderBookMessage, Security)
To update the order book.
public void UpdateDepth(IOrderBookMessage message, Security security = null)Parameters
messageIOrderBookMessageMarket depth.
securitySecuritySecurity.
UpdateFormat(Security)
To update PriceTextFormat and VolumeTextFormat.
public void UpdateFormat(Security security)Parameters
securitySecuritySecurity.
Events
CancelingOrder
Canceling order.
public event Action<Order> CancelingOrderEvent Type
MovingOrder
Moving order to new price.
public event Action<Order, decimal> MovingOrderEvent Type
RegisteringOrder
Registering order.
public event Action<Sides, decimal> RegisteringOrderEvent Type
SelectedQuoteChanged
SelectedQuote changed event.
public event Action<QuoteChange?> SelectedQuoteChanged