Class Root

Namespace

The.WPF.Composition

Assembly

Instagile.WPF.dll

public class Root : IServices, IServices, IDisposable

Inheritance

object

Root

Implements

IServices

IServices

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MenuBuilder.TriggerScreenLink(IServices, string)

Properties

AppName

public string AppName { get; }

Property Value

string

AppVersion

public string AppVersion { get; }

Property Value

string

Components

Functions to access built-in entity types added by model features.

public ComponentService Components { get; }

Property Value

ComponentService

Dispatcher

public Dispatcher Dispatcher { get; }

Property Value

Dispatcher

Documents

Functions to load and store files or images.

public DocumentService Documents { get; }

Property Value

DocumentService

Environment

public string Environment { get; }

Property Value

string

Export

public ExportService Export { get; }

Property Value

ExportService

Import

Functions for copying schema and data from external sources.

public ImportService Import { get; }

Property Value

ImportService

Licensing

public LicenseService Licensing { get; }

Property Value

LicenseService

Logging

public LogService Logging { get; }

Property Value

LogService

Mail

Functions to send email.

public MailService Mail { get; }

Property Value

MailService

Metadata

public EntityMetadataDictionary Metadata { get; }

Property Value

EntityMetadataDictionary

Persistence

Functions to load and store entities.

public PersistenceService Persistence { get; }

Property Value

PersistenceService

Preferences

public PreferenceService Preferences { get; }

Property Value

PreferenceService

RPC

Functions to execute registered procedures, either locally or via a remote IEndpoint.

public RPCService RPC { get; }

Property Value

RPCService

ReplaceSmartPunctuation

public bool ReplaceSmartPunctuation { get; }

Property Value

bool

Screens

public ScreenService Screens { get; }

Property Value

ScreenService

Security

public SecurityService Security { get; }

Property Value

SecurityService

Session

public SessionService Session { get; }

Property Value

SessionService

Sidebars

public SidebarService Sidebars { get; }

Property Value

SidebarService

Templates

public TemplateService Templates { get; }

Property Value

TemplateService

UICulture

public CultureInfo UICulture { get; }

Property Value

CultureInfo

Version

public string Version { get; }

Property Value

string

Methods

CreateAsync(Root, IShell, IControllerFactory, IPreferenceStore, OnAuthenticateAsync?, OnAuthenticateAsync?, Options)

public static Task<Root> CreateAsync(Root coreServices, IShell shell, IControllerFactory controllerFactory, IPreferenceStore preferenceStore, OnAuthenticateAsync? onLogin, OnAuthenticateAsync? onLogout, Options options)

Parameters

coreServices Root

shell IShell

controllerFactory IControllerFactory

preferenceStore IPreferenceStore

onLogin OnAuthenticateAsync

onLogout OnAuthenticateAsync

options Options

Returns

Task<Root>

CreateContext()

Create an entity context, the unit of work for data access, with the current identity.

public IEntityContext CreateContext()

Returns

IEntityContext

CreateContext(IPrincipal)

Create an entity context, the unit of work for data access.

public IEntityContext CreateContext(IPrincipal principal)

Parameters

principal IPrincipal

User identity for the created context.

Returns

IEntityContext

CreateSurface()

Create one of whatever the application considers a 'screen'.

public ISurface CreateSurface()

Returns

ISurface

DestroySurface(ISurface)

Initiate a closing process for one of the shell's screens. This will only work on surfaces returned from CreateSurface().

public void DestroySurface(ISurface surface)

Parameters

surface ISurface

Remarks

This method may be nonblocking.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetGlobalSurface()

Retrieve a singleton 'global' screen for contextless UI.

public ISurface GetGlobalSurface()

Returns

ISurface

ReloadSurface(ISurface, Func<Task>)

Initiate a reload process (caller-defined) for one of the shell's screens. This will only work on surfaces returned from CreateSurface().

public void ReloadSurface(ISurface surface, Func<Task> reload)

Parameters

surface ISurface

reload Func<Task>

Remarks

This method may be nonblocking.