Click or drag to resize
BCDocumentUI Class
Represents an object that manages a document.
Inheritance Hierarchy

Namespace: BlueCieloECM.InnoCielo.Meridian.Client
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.19.0)
Syntax
public class BCDocumentUI : DisposableObject

The BCDocumentUI type exposes the following members.

Constructors
  NameDescription
Public methodBCDocumentUI Obsolete.
Initializes a new instance of the BCDocumentUI class.
Public methodBCDocumentUI(BCDocument)
Initializes a new instance of the BCDocumentUI class.
Public methodBCDocumentUI(BCDocument, BCServiceProvider)
Initializes a new instance of the BCDocumentUI class.
Top
Properties
  NameDescription
Public propertyDocument
Gets the document under management.
Public propertyHasRenditionRedlines
Gets a value indicating whether the document has redlines rendition content.
Public propertyIsAmfs
Gets a value indicating whether AMFS share is used. If then the local workspace is used.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsEmpty
Gets a value indicating whether the document is empty.
Public propertyIsRedlinesEmpty
Gets a value indicating whether the document contains redline information.
Public propertyLockStatus
Gets the lock state of the document.
Public propertyOptions
Gets or sets options of document management.
Public propertyRedlinesFile
Loads/saves document redline information from/to the specified file.
Public propertyRendition
Gets the file path (local workspace or AMFS) to the file with rendition.
Public propertyRenditionRedlines
Gets the file path (local workspace or AMFS) to the file with redlines rendition.
Public propertyRenditionStatus
Gets the state of the document rendition.
Public propertyStatus
Gets the state of the object in the local workspace.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Top
Methods
  NameDescription
Public methodAddRendition(String)
Loads rendition content from the specified file.
Public methodAddRendition(String, Boolean)
Loads rendition content from the specified file.
Public methodAutoRename
Raises events that occur when the file name for an object is recalculated.
Public methodAutoRename(IWin32Window)
Raises events that occur when the file name for an object is recalculated.
Public methodClean
Cleans the content of the document.
Public methodDeleteRendition
Deletes rendition content.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExportRendition
Exports rendition content into the specified file.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLockInfo Obsolete.
Returns the lock state of the document.
Public methodGetStreamFile
Saves content of the specified stream to a temporary file.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImportFile
Replaces the document with the content of an external file.
Public methodImportFile(IWin32Window)
Replaces the document with the content of an external file.
Public methodImportFile(IWin32Window, Boolean, String, String)
Replaces the document with the content of an external file.
Public methodInit Obsolete.
Initializes the object with the document to manage.
Public methodLoadFromFile
Loads the content of the document from the specified file.
Public methodLocation
Returns a path to the object.
Public methodLocation(CacheSyncKind)
Synchronizes the object and returns a path to it.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDispose (Overrides DisposableObjectOnDispose.)
Public methodPutStreamFile(String, String)
Loads content of the stream from the specified file.
Public methodPutStreamFile(String, String, Boolean)
Loads content of the stream from the specified file.
Public methodReadTitleBlockFields
Synchronizes document's properties from title block.
Public methodRun
Opens a document file with default application.
Public methodRun(IWin32Window)
Opens a document file with default application.
Public methodSaveToFile
Saves the content of the document to the specified file.
Public methodScan
Replaces document content with newly scanned image.
Public methodScan(IWin32Window)
Replaces document content with newly scanned image.
Public methodSetLock
Changes a lock state of the document.
Public methodSetRenditionRedlines(String)
Loads redlines rendition content from the specified file.
Public methodSetRenditionRedlines(String, Boolean)
Loads redlines rendition content from the specified file.
Public methodShowStatus
Displays the conflict dialog box with the specified owner.
Public methodSync
Synchronizes the object in the local workspace with the vault.
Public methodSync(CacheSyncKind)
Synchronizes the object in the local workspace with the vault.
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateReferences
Synchronizes document's references.
Public methodUpdateRendition
Sends request to an external system (e.g. BlueCielo Publisher) to update rendition content.
Public methodWriteTitleBlockFields
Synchronizes document's properties to title block.
Top
See Also