Class CandleMessage
- Namespace
 - StockSharp.Messages
 
- Assembly
 - StockSharp.Messages.dll
 
The message contains information about the candle.
[DataContract]
public abstract class CandleMessage : Message, ICloneable<Message>, IMessage, ICloneable, ISubscriptionIdMessage, IOriginalTransactionIdMessage, ICandleMessage, ISecurityIdMessage, ISeqNumMessage, IGeneratedMessage, ILocalTimeMessage, IServerTimeMessage
  - Inheritance
 - 
      
      
      
      CandleMessage
 
- Implements
 
- Derived
 
- Inherited Members
 
- Extension Methods
 
Remarks
Initialize CandleMessage.
Constructors
CandleMessage(MessageTypes)
The message contains information about the candle.
protected CandleMessage(MessageTypes type)
  Parameters
typeMessageTypesMessage type.
Remarks
Initialize CandleMessage.
Properties
Arg
public abstract object Arg { get; }
  Property Value
ArgType
Arg type.
public abstract Type ArgType { get; }
  Property Value
BuildFrom
Determines the message is generated from the specified DataType.
[DataMember]
public DataType BuildFrom { get; set; }
  Property Value
BuyVolume
Buy volume.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "BuyVolume", GroupName = "General")]
public decimal? BuyVolume { get; set; }
  Property Value
ClosePrice
Closing price.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "ClosingPrice", Description = "ClosePriceOfCandle", GroupName = "General")]
[BasicSetting]
public decimal ClosePrice { get; set; }
  Property Value
CloseTime
Close time.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleCloseTime", Description = "CandleCloseTime", GroupName = "General")]
public DateTimeOffset CloseTime { get; set; }
  Property Value
CloseVolume
Volume at close.
[DataMember]
public decimal? CloseVolume { get; set; }
  Property Value
DataType
Data type info.
public DataType DataType { get; set; }
  Property Value
DownTicks
Number of down trending ticks.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TickDown", Description = "TickDownCount", GroupName = "General")]
public int? DownTicks { get; set; }
  Property Value
- int?
 
HighPrice
Highest price.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "HighestPrice", Description = "HighPriceOfCandle", GroupName = "General")]
[BasicSetting]
public decimal HighPrice { get; set; }
  Property Value
HighTime
High time.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleHighTime", Description = "CandleHighTime", GroupName = "General")]
public DateTimeOffset HighTime { get; set; }
  Property Value
HighVolume
Volume at high.
[DataMember]
public decimal? HighVolume { get; set; }
  Property Value
LowPrice
Lowest price.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "LowestPrice", Description = "LowPriceOfCandle", GroupName = "General")]
[BasicSetting]
public decimal LowPrice { get; set; }
  Property Value
LowTime
Low time.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleLowTime", Description = "CandleLowTime", GroupName = "General")]
public DateTimeOffset LowTime { get; set; }
  Property Value
LowVolume
Volume at low.
[DataMember]
public decimal? LowVolume { get; set; }
  Property Value
OpenInterest
Open interest.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "OI", Description = "OpenInterestDesc", GroupName = "General")]
public decimal? OpenInterest { get; set; }
  Property Value
OpenPrice
Opening price.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "OpenPrice", Description = "CandleOpenPrice", GroupName = "General")]
[BasicSetting]
public decimal OpenPrice { get; set; }
  Property Value
OpenTime
Open time.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleOpenTime", Description = "CandleOpenTime", GroupName = "General")]
[BasicSetting]
public DateTimeOffset OpenTime { get; set; }
  Property Value
OpenVolume
Volume at open.
[DataMember]
public decimal? OpenVolume { get; set; }
  Property Value
OriginalTransactionId
ID of the original message TransactionId for which this message is a response.
[DataMember]
public long OriginalTransactionId { get; set; }
  Property Value
PriceLevels
Price levels.
[DataMember]
public IEnumerable<CandlePriceLevel> PriceLevels { get; set; }
  Property Value
RelativeVolume
Relative volume.
[DataMember]
public decimal? RelativeVolume { get; set; }
  Property Value
SecurityId
Security ID.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "SecurityId", Description = "SecurityId", GroupName = "General")]
[BasicSetting]
public SecurityId SecurityId { get; set; }
  Property Value
SellVolume
Sell volume.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "SellVolume", GroupName = "General")]
public decimal? SellVolume { get; set; }
  Property Value
SeqNum
Sequence number.
[DataMember]
public long SeqNum { get; set; }
  Property Value
Remarks
Zero means no information.
State
State.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "State", Description = "CandleState", GroupName = "General")]
public CandleStates State { get; set; }
  Property Value
SubscriptionId
Subscription id.
public long SubscriptionId { get; set; }
  Property Value
SubscriptionIds
Identifiers.
public long[] SubscriptionIds { get; set; }
  Property Value
- long[]
 
TotalPrice
Total price size.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TotalPrice", GroupName = "General")]
public decimal TotalPrice { get; set; }
  Property Value
TotalTicks
Number of ticks.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "Ticks", Description = "TickCount", GroupName = "General")]
public int? TotalTicks { get; set; }
  Property Value
- int?
 
TotalVolume
Total volume.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "Volume", Description = "TotalCandleVolume", GroupName = "General")]
[BasicSetting]
public decimal TotalVolume { get; set; }
  Property Value
UpTicks
Number of up trending ticks.
[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "TickUp", Description = "TickUpCount", GroupName = "General")]
public int? UpTicks { get; set; }
  Property Value
- int?
 
Methods
CopyTo(CandleMessage)
Copy parameters.
protected CandleMessage CopyTo(CandleMessage copy)
  Parameters
copyCandleMessageCopy.
Returns
- CandleMessage
 Copy.
ToString()
public override string ToString()