Load Method, SftTree Object
Loads the control contents.
Syntax
| VB.NET | object.Load(ByVal Filename As String, ByVal StreamName As String, ByVal Format As SftTreeSaveFormatConstants, ByRef PropertiesLoaded As Object, ByVal Stream As IStream) |
| VB | object.Load(ByVal Filename As String, ByVal StreamName As String, ByVal Format As SftTreeSaveFormatConstants, PropertiesLoaded As Variant, Stream As IStream) |
| C#.NET | void object.Load(string Filename, string StreamName, SftTreeSaveFormatConstants Format, out object PropertiesLoaded, IStream Stream); |
| VC++ | HRESULT object->Load(_bstr_t Filename, _bstr_t StreamName, enum SftTreeSaveFormatConstants Format, const _variant_t&* PropertiesLoaded, IStream* Stream); |
| C | HRESULT object->raw_Load(BSTR Filename, BSTR StreamName, enum SftTreeSaveFormatConstants Format, VARIANT* PropertiesLoaded, IStream* Stream); |
object
A SftTree object.
Filename
A file name, from where the contents are to be loaded. If the Filename argument is not NULL/Nothing, the Stream, StreamName arguments must be NULL/Nothing.
StreamName
Reserved for future use - Ignored. A stream name (part of the compound file FileName), from where the contents are to be loaded.
Format
Defines the format of the data being loaded.
| Name | Value | Description |
|---|
| saveFormatSftTreeStream | 0 | Stream |
| saveFormatSftTreePropertyPages | 1 | Stream as used by Property Page dialog (Load/Save Properties) - always saves all properties. The filename must be specified and the PropertiesLoaded argument is ignored. |
PropertiesLoaded
Set to True to load tree control properties (in addition to items and their attributes), False to load just the items and their attributes. If the saved data doesn't contain data matching the requested data, an error occurs. This value must match the Properties argument of the Save method used to save the data.
Stream
The stream (IStream interface) from where the data is loaded. The Stream argument must be NULL/Nothing, if the Filename argument is not NULL/Nothing.
Comments
The Load method loads the control contents.
The Save method can be used to save the control contents in a format suitable for the Load method.
The Save/Load methods are intended for design-time property saving/loading to transfer the settings between controls. While items are also transferred, this is not recommended to be exploited by applications for quick data loading, as any images used in the control are saved in their entirety. Images shared between items (i.e., using the same image reference) will be individually copied resulting in excessive memory/windows handle use.
See Also SftTree Object | Object Hierarchy
On
Off