IDocument Interface

Provides methods to work with a document created with the IDocumentManagerService.

Namespace: DevExpress.Mvvm

Assembly: DevExpress.Mvvm.v22.1.dll

Declaration

C#

public interface IDocument

VB.NET

Public Interface IDocument

Related API Members

The following members return IDocument objects:

Show 17 links

Library	Related API Members
Cross-Platform Class Library	DocumentManagerServiceExtensions.CreateDocument(IDocumentManagerService, Object)
	DocumentManagerServiceExtensions.CreateDocument(IDocumentManagerService, String, Object, Object)
	DocumentManagerServiceExtensions.CreateDocument(IDocumentManagerService, String, Object)
	DocumentManagerServiceExtensions.CreateDocument<TEntity>(IDocumentManagerService, Object, Object)
	DocumentManagerServiceExtensions.FindDocument(IDocumentManagerService, Object, Object)
	DocumentManagerServiceExtensions.FindDocument(IDocumentManagerService, Object)
	DocumentManagerServiceExtensions.FindDocumentById(IDocumentManagerService, Object)
	DocumentManagerServiceExtensions.FindDocumentByIdOrCreate(IDocumentManagerService, Object, Func<IDocumentManagerService, IDocument>)
	DocumentManagerServiceExtensions.FindEntityDocument<TEntity, TPrimaryKey>(IDocumentManagerService, TPrimaryKey)
	DocumentManagerServiceExtensions.ShowExistingEntityDocument<TEntity, TPrimaryKey>(IDocumentManagerService, Object, TPrimaryKey, Object)
	DocumentManagerServiceExtensions.ShowNewEntityDocument<TEntity>(IDocumentManagerService, Object, Action<TEntity>)
	DocumentsViewModel<TModule, TUnitOfWork>.ShowCore(TModule)
	IDocumentManagerService.ActiveDocument
	IDocumentManagerService.CreateDocument(String, Object, Object, Object)
WPF Controls	FrameDocumentUIService.ActiveDocument
	NavigationServiceBase.ActiveDocument
	WindowedDocumentUIService.ActiveDocument

Remarks

See Services to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IDocument interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

lesson-6-multi-level-navigation-in-mvpvm-applications-t146514/CS/MvpvmNavigation/ViewModels/EditFormViewModel.cs#L7

public class EditFormViewModel : IDocumentContent {
    public IDocument Document { get; set; }
    public bool? Result { get; private set; }

mvvmexpenses-sample-application-t254492/CS/MVVMExpenses/Common/ViewModel/DocumentsViewModel.cs#L41

    .Except(LogicalLayoutSerializationHelper.GetImmediateChildren(this));
foreach(IDocument orphan in orphans) {
    orphan.DestroyOnClose = true;

wcf-data-service-and-a-client-application-t198896/CS/Scaffolding.WCF/Common/ViewModel/DocumentManagerServiceExtensions.cs#L19

/// <param name="primaryKey">An entity primary key.</param>
public static IDocument ShowExistingEntityDocument<TEntity, TPrimaryKey>(this IDocumentManagerService documentManagerService, object parentViewModel, TPrimaryKey primaryKey) {
    IDocument document = FindEntityDocument<TEntity, TPrimaryKey>(documentManagerService, primaryKey) ?? CreateDocument<TEntity>(documentManagerService, primaryKey, parentViewModel);

how-to-build-an-office-inspired-application-t111486/CS/PersonalOrganizer/Common/ViewModel/DocumentsViewModel.cs#L47

    return;
IDocument document = DocumentManagerService.FindDocumentByIdOrCreate(module, x => CreateDocument(module));
document.Show();

how-to-save-opened-documents-their-layout-and-layout-of-the-documents-views-t328880/CS/WindowsApplication3/ViewModels/DocumentsViewModel.cs#L44

}
public IDocument ShowCore(ModuleDescription module) {
    if (module == null || DocumentManagerService == null)

VB.NET

lesson-6-multi-level-navigation-in-mvpvm-applications-t146514/VB/MvpvmNavigation/ViewModels/EditFormViewModel.vb#L9

Public Property Document() As IDocument
Private privateResult? As Boolean

mvvmexpenses-sample-application-t254492/VB/MVVMExpenses/Common/ViewModel/DocumentsViewModel.vb#L37

Dim orphans = LogicalLayoutSerializationHelper.GetOrphanedDocuments(Me).Except(LogicalLayoutSerializationHelper.GetImmediateChildren(Me))
For Each orphan As IDocument In orphans
    orphan.DestroyOnClose = True

how-to-build-an-office-inspired-application-t111486/VB/PersonalOrganizer/Common/ViewModel/DocumentsViewModel.vb#L53

End If
Dim document As IDocument = DocumentManagerService.FindDocumentByIdOrCreate([module], Function(ByVal x) CreateDocument([module]))
document.Show()

how-to-save-opened-documents-their-layout-and-layout-of-the-documents-views-t328880/VB/WindowsApplication3/ViewModels/DocumentsViewModel.vb#L68

End Sub
Public Function ShowCore(ByVal [module] As ModuleDescription) As IDocument
    If [module] Is Nothing OrElse DocumentManagerService Is Nothing Then

how-to-create-a-custom-dialogservice-with-custom-commands-t590911/VB/DXApplication5/MVVM/ViewModels/DocumentsViewModel.vb#L25

If DocumentType <> DocumentType.None AndAlso DocumentManagerService IsNot Nothing Then
    Dim document As IDocument = DocumentManagerService.FindDocumentByIdOrCreate(DocumentType, Function(x) CreateDocument())
    document.Show()