| BCDocumentUI Class |
Represents an object that manages a document.
Inheritance HierarchySystemObject
BlueCieloECM.InnoCielo.MeridianDisposableObject
BlueCieloECM.InnoCielo.Meridian.ClientBCDocumentUI
BlueCieloECM.InnoCielo.MeridianDisposableObject
BlueCieloECM.InnoCielo.Meridian.ClientBCDocumentUI
Namespace: BlueCieloECM.InnoCielo.Meridian.Client
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.19.0)
SyntaxThe BCDocumentUI type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BCDocumentUI | Obsolete.
Initializes a new instance of the BCDocumentUI class.
|
| BCDocumentUI(BCDocument) |
Initializes a new instance of the BCDocumentUI class.
|
| BCDocumentUI(BCDocument, BCServiceProvider) |
Initializes a new instance of the BCDocumentUI class.
|
Properties| Name | Description | |
|---|---|---|
 | Document |
Gets the document under management.
|
| HasRenditionRedlines |
Gets a value indicating whether the document
has redlines rendition content.
|
| IsAmfs |
Gets a value indicating whether AMFS share is used.
If then the local workspace is used.
|
| IsDisposed |
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.) |
| IsEmpty |
Gets a value indicating whether the document is empty.
|
| IsRedlinesEmpty |
Gets a value indicating whether the document contains redline information.
|
| LockStatus |
Gets the lock state of the document.
|
| Options |
Gets or sets options of document management.
|
| RedlinesFile |
Loads/saves document redline information from/to the specified file.
|
| Rendition |
Gets the file path (local workspace or AMFS)
to the file with rendition.
|
| RenditionRedlines |
Gets the file path (local workspace or AMFS)
to the file with redlines rendition.
|
| RenditionStatus |
Gets the state of the document rendition.
|
| Status |
Gets the state of the object in the local workspace.
|
| UnderlyingObject |
Gets the underlying wrapped object.
(Inherited from DisposableObject.) |
Methods| Name | Description | |
|---|---|---|
| AddRendition(String) |
Loads rendition content from the specified file.
|
| AddRendition(String, Boolean) |
Loads rendition content from the specified file.
|
| AutoRename |
Raises events that occur when the file name for an object is recalculated.
|
| AutoRename(IWin32Window) |
Raises events that occur when the file name for an object is recalculated.
|
| Clean |
Cleans the content of the document.
|
| DeleteRendition |
Deletes rendition content.
|
| Dispose |
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.) |
| Equals | (Inherited from Object.) |
| ExportRendition |
Exports rendition content into the specified file.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLockInfo | Obsolete.
Returns the lock state of the document.
|
| GetStreamFile |
Saves content of the specified stream to a temporary file.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportFile |
Replaces the document with the content of an external file.
|
| ImportFile(IWin32Window) |
Replaces the document with the content of an external file.
|
| ImportFile(IWin32Window, Boolean, String, String) |
Replaces the document with the content of an external file.
|
| Init | Obsolete.
Initializes the object with the document to manage.
|
| LoadFromFile |
Loads the content of the document from the specified file.
|
| Location |
Returns a path to the object.
|
| Location(CacheSyncKind) |
Synchronizes the object and returns a path to it.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDispose |
The method is called on Dispose.
(Overrides DisposableObjectOnDispose.) |
| PutStreamFile(String, String) |
Loads content of the stream from the specified file.
|
| PutStreamFile(String, String, Boolean) |
Loads content of the stream from the specified file.
|
| ReadTitleBlockFields |
Synchronizes document's properties from title block.
|
| Run |
Opens a document file with default application.
|
| Run(IWin32Window) |
Opens a document file with default application.
|
| SaveToFile |
Saves the content of the document to the specified file.
|
| Scan |
Replaces document content with newly scanned image.
|
| Scan(IWin32Window) |
Replaces document content with newly scanned image.
|
| SetLock |
Changes a lock state of the document.
|
| SetRenditionRedlines(String) |
Loads redlines rendition content from the specified file.
|
| SetRenditionRedlines(String, Boolean) |
Loads redlines rendition content from the specified file.
|
| ShowStatus |
Displays the conflict dialog box with the specified owner.
|
| Sync |
Synchronizes the object in the local workspace with the vault.
|
| Sync(CacheSyncKind) |
Synchronizes the object in the local workspace with the vault.
|
| ThrowIfDisposed |
Throws the ObjectDisposedException exception if
the underlying object has been disposed.
(Inherited from DisposableObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateReferences |
Synchronizes document's references.
|
| UpdateRendition |
Sends request to an external system (e.g. BlueCielo Publisher) to update rendition content.
|
| WriteTitleBlockFields |
Synchronizes document's properties to title block.
|
See Also