Interface ICompoundStorage
This interface represents storage object in the compound file.
Namespace: Syncfusion.CompoundFile.DocIO
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public interface ICompoundStorage : IDisposableProperties
Name
Returns name of the storage.
Declaration
string Name { get; }Property Value
| Type |
|---|
| System.String |
Storages
Returns all storage names that are placed inside this stream.
Declaration
string[] Storages { get; }Property Value
| Type |
|---|
| System.String[] |
Streams
Returns all stream names that are placed inside this stream.
Declaration
string[] Streams { get; }Property Value
| Type |
|---|
| System.String[] |
Methods
ContainsStorage(String)
Determines whether this storage contains substorage with specified name.
Declaration
bool ContainsStorage(string storageName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storageName | Name of the storage to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if storage contains substorage with specified name. |
ContainsStream(String)
Determines whether storage contains specified stream.
Declaration
bool ContainsStream(string streamName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | streamName | Name of the stream to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if storage contains specified stream. |
CreateStorage(String)
Creates new substorage inside this one.
Declaration
ICompoundStorage CreateStorage(string storageName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storageName | Name of the storage to create. |
Returns
| Type | Description |
|---|---|
| ICompoundStorage | Created storage object. |
CreateStream(String)
Creates new stream inside this storage.
Declaration
CompoundStream CreateStream(string streamName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | streamName | Name of the stream to create. |
Returns
| Type | Description |
|---|---|
| CompoundStream | Created stream object. |
DeleteStorage(String)
Removes exisiting substorage from this one.
Declaration
void DeleteStorage(string storageName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storageName | Name of the storage to remove. |
DeleteStream(String)
Removes existing stream from this storage.
Declaration
void DeleteStream(string streamName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | streamName | Name of the stream to remove. |
Flush()
Commits changes.
Declaration
void Flush()InsertCopy(CompoundStream)
Inserts copy of the stream inside current storage.
Declaration
void InsertCopy(CompoundStream streamToCopy)Parameters
| Type | Name | Description |
|---|---|---|
| CompoundStream | streamToCopy | Stream to copy. |
InsertCopy(ICompoundStorage)
Inserts copy of the storage and all subitems inside current storage.
Declaration
void InsertCopy(ICompoundStorage storageToCopy)Parameters
| Type | Name | Description |
|---|---|---|
| ICompoundStorage | storageToCopy | Storage to copy. |
OpenStorage(String)
Opens existing substorage inside this one.
Declaration
ICompoundStorage OpenStorage(string storageName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storageName | Name of the storage to open. |
Returns
| Type | Description |
|---|---|
| ICompoundStorage | Created storage object. |
OpenStream(String)
Opens existing stream inside this storage.
Declaration
CompoundStream OpenStream(string streamName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | streamName | Name of the stream to open. |
Returns
| Type |
|---|
| CompoundStream |