API documentation, members, signatures, and C# examples.
Find classes, members, and documentation.
The DataSet class represents a DataSet in WL9, either created by the user using the New DataSet Wizard, or generated by a DataSet Provider. DataSet Providers can return instances of classes derived from DataSet, allowing them to customize behavior such as symbol membership, historical data retrieval, and supported scales. DataSet implements the IHistoryProvider and INamed interfaces.
public virtual bool AllowReconfigureReturns whether the DataSet can be reconfigured. If the DataSet has an associated DataProvider, the default implementation returns the provider's AllowConfigurationOfExistingDataSets value. Otherwise, it returns true.
public DataProviderBase DataProviderReturns or assigns the Historical Data Provider associated with the DataSet. If no provider has been explicitly assigned, the getter attempts to locate the provider specified by PreferredDataProviderName.
public object DataSetProviderContains a reference to the DataSet Provider associated with this DataSet, if any.
public string DSStringContains configuration information associated with the DataSet. How the DSString is interpreted depends on the Historical Data Provider or DataSet Provider that created the DataSet.
public List<DateRange> DynamicDateRangespublic virtual string GlyphResourceReturns or assigns the name of an embedded resource used to represent the DataSet in the WL9 DataSets tree. If no resource was explicitly assigned, the associated DataProvider glyph is used. If no DataProvider is available, WL9 uses its default DataSet glyph.
public bool IsDynamicReturns true if the DataSet is dynamic. A user-created DataSet is dynamic when IsDynamicEnabled is true and DynamicDateRanges contains at least one entry. DataSet-derived classes created by DataSet Providers can also indicate that they are dynamic.
public bool IsDynamicEnabledIndicates whether the Dynamic option was enabled when the DataSet was created in the New DataSet Wizard.
public bool IsHiddenDetermines whether the DataSet should be hidden from the normal WL9 user interface.
public bool IsUserCreatedReturns true if the DataSet was created by the user in WL9, typically through the New DataSet Wizard, and false if it was created by a DataSet Provider.
public string NameContains the name of the DataSet.
public string PreferredDataProviderNameContains the name of the preferred Historical Data Provider for this DataSet. WL9 will attempt to use this provider when obtaining historical data for the DataSet.
public string QualifiedNameReturns a name that can uniquely identify the DataSet when multiple DataSet Providers produce DataSets having the same Name. If PreferredDataProviderName is assigned, the returned value consists of Name, a semicolon, and PreferredDataProviderName. Otherwise, it returns Name.
public bool ReadOnlySymbolsDetermines whether the user is permitted to modify the symbols in the DataSet.
public virtual bool ShouldReturnOwnDataReturns whether the DataSet is responsible for providing its own historical data. The default implementation returns false, causing WL9 to use its normal Historical Data Provider mechanism. Override this property to return true in a DataSet-derived class that implements its own historical data retrieval.
public List<string> SortedSymbolsReturns the DataSet's symbols sorted alphabetically.
public List<string> SymbolsContains the symbols in the DataSet. Assigning this property replaces the existing symbol list and sorts the supplied symbols alphabetically.
public string SymbolStringGets or sets the DataSet's Symbols as a single storage-formatted string. Setting this property parses the string and replaces the current symbol list.
public virtual List<string> TradableSymbolsReturns the symbols that are currently tradable. The default implementation returns Symbols. Override this property to return a subset of the DataSet symbols, for example to exclude decommissioned securities. WL9 uses this property in areas such as the Strategy Monitor.
public bool AllowConfigurationOfExistingDataSets()Returns whether the DataSet can be reconfigured based on its associated Historical Data Provider. If no provider is associated with the DataSet, the method returns true.
public DataProviderBase GetDataProvider(bool useDefaultWD)Returns the Historical Data Provider associated with the DataSet and initializes it if required. If no provider is associated and useDefaultWD is true, the method attempts to use the WealthData provider. If useDefaultWD is false and no provider is associated, it returns null.
public virtual BarHistory GetHistory(string symbol, HistoryScale scale, DateTime startDate, DateTime endDate, int maxBars, DataRequestOptions cb)Override this method when ShouldReturnOwnData returns true to provide historical data for the specified symbol and scale. Return a BarHistory containing the requested data. The startDate, endDate, and maxBars parameters describe the requested range, and cb contains additional data request options. The base implementation returns null.
public static DataSet Parse(string s)Creates and returns a DataSet from its legacy persisted string representation. This method is deprecated.
public static DataSet ParseXML(string xml)Creates and returns a DataSet by deserializing the XML representation supplied in xml.
public string Persist()Returns a legacy string representation of the DataSet suitable for persistence. This method is deprecated.
public string PersistXML()Serializes the DataSet to XML and returns the resulting string.
public virtual void PostDataLoad(BarHistory bh)WL9 calls this method after historical data has been loaded for a symbol in the DataSet. The default implementation applies matching entries in DynamicDateRanges to the supplied BarHistory by calling its AddExecutableRange method. Override this method to perform additional post-processing, but call base.PostDataLoad(bh) to retain the dynamic DataSet behavior.
public virtual bool SupportsScale(HistoryScale scale)Returns whether a DataSet that supplies its own historical data supports the specified scale. The default implementation returns true. Derived DataSet classes that override ShouldReturnOwnData can override this method to restrict the supported scales.
Ask the community or explore custom development services.