AccessDocument
OfficeIMO.Access
A typed Access model with explicit operation qualification. Instances are not thread-safe.
Inheritance
- object
- AccessDocument
Usage
Explore 4 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
- Method AccessDocument.Create
- Method AccessDocument.Load
- Method AccessDocument.LoadAsync
Accepted by parameters 1
Methods
public AccessOperationReport AssessSave(AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Assesses a native save without writing output or accepting unsupported codecs.
Parameters
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessOperationReportpublic AccessOperationReport AssessSave(string path, AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Assesses native output for a path, including explicit format/extension agreement.
Parameters
- path string
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessOperationReportpublic AccessUpdateScope BeginUpdate() #Begins a model edit scope. Disposal rolls back unless Commit succeeds; database transactions are separate.
Returns
AccessUpdateScopepublic static AccessDocument Create(AccessCreateOptions? options = null) #Creates an in-memory model without writing a file.
Parameters
- options OfficeIMO.Access.AccessCreateOptions? = null
Returns
AccessDocumentpublic static AccessDocument Create(string path, AccessCreateOptions? options = null) #Creates a model associated with a validated path; no directory or file is created.
Parameters
- path string
- options OfficeIMO.Access.AccessCreateOptions? = null
Returns
AccessDocumentpublic static AccessDocument Create(Stream stream, AccessCreateOptions? options = null) #Creates a model associated with a writable, seekable caller-owned stream. No bytes are written.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Access.AccessCreateOptions? = null
Returns
AccessDocumentpublic void Dispose() #Discards pending model edits and releases the document. Caller-owned streams remain open.
public OfficeVbaProject GetVbaProject(OfficeVbaReadOptions? options = null, CancellationToken cancellationToken = default) #Loads a detached editable VBA project from the decoded native application storage.
Parameters
- options OfficeIMO.OfficeVbaReadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeVbaProjectpublic static AccessInspection Inspect(string path, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Inspects a bounded native file without opening Access or executing active content.
Parameters
- path string
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessInspectionpublic static AccessInspection Inspect(Stream stream, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Inspects caller-owned input. Seekable input starts at zero and its position is restored.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessInspectionpublic static AccessDocument Load(string path, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Loads a bounded native catalog and selected schemas. User rows and large field values are decoded on demand.
Parameters
- path string
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessDocumentpublic static AccessDocument Load(Stream stream, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Loads caller-owned input into a bounded immutable snapshot without retaining or closing the stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AccessDocumentpublic static async Task<AccessDocument> LoadAsync(string path, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously snapshots a bounded file and inspects its native header.
Parameters
- path string
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<AccessDocument>public static async Task<AccessDocument> LoadAsync(Stream stream, AccessLoadOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously snapshots caller-owned input, retaining its seekable position and leaving it open.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Access.AccessLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<AccessDocument>public void Save(AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Requests associated persistence. An unsupported writer fails before touching any destination.
Parameters
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public void Save(string path, AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Requests native file output. Unsupported codecs fail before creating directories, files or temporary output.
Parameters
- path string
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public void Save(Stream stream, AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Requests native stream output. The caller's position, length and ownership remain unchanged on unsupported output.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task SaveAsync(string path, AccessSaveOptions? options = null, CancellationToken cancellationToken = default) #Saves qualified native output and returns a completed, failed or cancelled task. Encoding is synchronous.
Parameters
- path string
- options OfficeIMO.Access.AccessSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic void SetVbaProject(OfficeVbaProject project, OfficeVbaWriteOptions? options = null, CancellationToken cancellationToken = default) #Stages a shared VBA project in a qualified native MDB/ACCDB snapshot. Call Save to persist it.
Parameters
- project OfficeIMO.OfficeVbaProject
- options OfficeIMO.OfficeVbaWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public void ValidateSourceIdentity(CancellationToken cancellationToken = default) #Checks a loaded path against its full snapshot identity. Stream snapshots have no retained external source.
Parameters
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
Properties
public long Revision { get; private set; } #Mutation revision. Rollback restores its starting revision.
public bool IsModified { get; } #Whether the model has edits. No native persistence is implied.
public bool HasActiveUpdate { get; } #Whether an edit scope must finish before reads or assessment.
public AccessCatalogStatus CatalogStatus { get; internal set; } #Whether the loaded catalog is decoded or the objects are a new model.
public AccessFormatProfile Profile { get; } #Selected or detected physical generation.
public DocumentPersistenceMode PersistenceMode { get; } #Native creation and unchanged snapshot preservation require an explicit Save.
public AccessInspection? Inspection { get; } #Bounded native header evidence; null for a newly created model.
public AccessTableCollection Tables { get; } #Modeled tables; native catalog decoding is a separate capability.
public AccessObjectCollection<AccessTable> SystemTables { get; } #System and hidden table definitions, separate from ordinary user tables. Opening them never executes database logic.
public AccessObjectCollection<AccessCatalogEntry> Catalog { get; } #Inert native catalog entries, including system and unknown objects. Catalog inventory does not decode application payloads.
public IReadOnlyList<AccessDiagnostic> Diagnostics { get; internal set; } #Document-level decoding limits and unsupported-content diagnostics.
public IReadOnlyDictionary<string, object?> Properties { get; internal set; } #Persisted database properties, including the AccessVersion format marker. Expressions remain inert.
public AccessOpaqueValue? NativeProperties { get; internal set; } #Exact database property map, including unqualified chunks.
public int? CodePage { get; internal set; } #Stored database code page. Jet3 uses qualified single-byte maps; Jet4/ACE text values use Unicode. Unsupported encodings are not converted lossily.
public int? SortOrder { get; internal set; } #Stored collation identifier. Reading metadata does not implement engine sorting or query evaluation.
public AccessRelationshipCollection Relationships { get; } #Typed modeled relationships.
public AccessObjectCollection<AccessApplicationObject> Forms { get; } #Form metadata boundary. Check CatalogStatus before interpreting absence.
public AccessObjectCollection<AccessApplicationObject> Reports { get; } #Report metadata boundary. Check CatalogStatus before interpreting absence.
public AccessObjectCollection<AccessApplicationObject> Macros { get; } #Action macro metadata boundary, separate from VBA.
public AccessVbaProjectInfo VbaProject { get; internal set; } #Inert VBA inventory availability.
public IReadOnlyList<AccessStorageStream> ApplicationStreams { get; internal set; } #Inert application storage streams with native paths, including unknown and compiled content.
public IReadOnlyList<AccessDependency> Dependencies { get; internal set; } #Inert observed query, designer and relationship references. This is a partial dependency map, never an expression engine.
public IReadOnlyList<AccessDataMacroInfo> DataMacros { get; internal set; } #Qualified native table data-macro XML definitions. Actions and expressions are retained without execution.
public IReadOnlyList<AccessResourceInfo> Resources { get; internal set; } #Native resource metadata; embedded payloads use the existing lazy attachment reader.
public IReadOnlyList<AccessChange> ChangeJournal { get; } #Committed or pending model mutations; rollback removes mutations from its scope.
public IReadOnlyList<AccessOperationCapability> Capabilities { get; } #Operation boundaries for this document state, including unsupported native operations.