Save Method, SftTree Object
Saves the control contents.
Syntax
| VB.NET | object.Save(ByVal Filename As String, ByVal StreamName As String, ByVal Format As SftTreeSaveFormatConstants, ByVal Properties As Boolean, ByRef Stream As IStream) |
| VB | object.Save(ByVal Filename As String, ByVal StreamName As String, ByVal Format As SftTreeSaveFormatConstants, ByVal Properties As Boolean, Stream As IStream) |
| C#.NET | void object.Save(string Filename, string StreamName, SftTreeSaveFormatConstants Format, bool Properties, out IStream Stream); |
| VC++ | HRESULT object->Save(_bstr_t Filename, _bstr_t StreamName, enum SftTreeSaveFormatConstants Format, VARIANT_BOOL Properties, IStream** Stream); |
| C | HRESULT object->raw_Save(BSTR Filename, BSTR StreamName, enum SftTreeSaveFormatConstants Format, VARIANT_BOOL Properties, IStream** Stream); |
object
A SftTree object.
Filename
A file name, where the contents are saved. If this file exists, it is overwritten. 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), where the contents are saved. If this stream exists, it is overwritten.
Format
Defines the format of the saved data.
| 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. |
Properties
Set to True to save tree control properties (in addition to items and their attributes), False to save just the items and their attributes.
Stream
The stream (IStream interface) where the data is saved. The Stream argument must be NULL/Nothing, if the Filename argument is not NULL/Nothing.
Comments
The Save method saves the control contents.
The Load method can be used to load the control contents saved using the Save 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