File

projects/wms-framework/src/lib/regionsframework/IRegionManager.ts

Description

Interface for region manager

Index

Properties
Methods

Methods

AddToRegion
AddToRegion(regionName: string, obj: unknown)

Adds to region

Parameters :
Name Type Optional
regionName string No
obj unknown No
Returns : void
CreateRegionManager
CreateRegionManager(container?: DependencyContainer)

Creates a new region manager.

Parameters :
Name Type Optional
container DependencyContainer Yes
Returns : IRegionManager
RegisterRegionTarget
RegisterRegionTarget(regionName: string, view: UIElement)

Register region target.

Parameters :
Name Type Optional
regionName string No
view UIElement No
Returns : any
RegisterViewWithRegion
RegisterViewWithRegion(regionName: string, viewCreationFunc: | RuntimeTypeInfo)

Register view with region

Parameters :
Name Type Optional
regionName string No
viewCreationFunc | RuntimeTypeInfo No
Returns : void

Properties

Regions
Regions: IRegionCollection
Type : IRegionCollection
import { DependencyContainer } from 'tsyringe';
import { UIElement } from '../basecomponentmodel/UIElement';
import { RuntimeTypeInfo } from '../baseframework/ReflectionSupport';
import type { IRegionCollection } from './IRegionCollection';

/**
 *  Interface for region manager
 *
 * @export
 * @interface IRegionManager
 * @wInterface Microsoft.Practices.Prism.Regions.IRegionManager
 */
export interface IRegionManager {
  Regions: IRegionCollection;

  /**
   * Creates a new region manager.
   */
  CreateRegionManager(container?: DependencyContainer): IRegionManager;

  /**
   * Register region target.
   *
   * @param {string} regionName
   * @param {UIElement} view
   * @returns {*}
   * @memberof IRegionManager
   * @wIgnore
   */
  RegisterRegionTarget(regionName: string, view: UIElement): any;

  /**
   * Register view with region
   *
   * @param {string} regionName
   * @param {(((() => unknown) | RuntimeTypeInfo))} viewCreationFunc
   * @memberof IRegionManager
   * @wIgnore
   */
  RegisterViewWithRegion(
    regionName: string,
    viewCreationFunc: (() => unknown) | RuntimeTypeInfo
  ): void;

  /**
   * Adds to region
   *
   * @param {string} regionName
   * @param {unknown} obj
   * @memberof IRegionManager
   * @wIgnore
   */
  AddToRegion(regionName: string, obj: unknown): void;
}

result-matching ""

    No results matching ""