WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridEngineFactoryBase - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridEngineFactoryBase

    A factory class object with the purpose of instantiating a GridEngine object.

    Inheritance
    System.Object
    GridEngineFactoryBase
    AllowResizingIndividualRows
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class GridEngineFactoryBase
    Remarks

    The virtual GridGroupingControl.CreateEngine function by default calls GridEngineFactory.CreateEngine to create an engine object.

    There are multiple alternatives that let you customize the engine object that is used within a GridGroupingControl.

    • A global solution for all controls in your app is to derive a class from GridEngineFactoryBase, override CreateEngine, and assign an instance of the derived GridEngineFactoryBase object to GridEngineFactory.Factory.
    • Instantiate manually a GridEngine object and call the constructor of GridGroupingControl, passing in the engine object as parameter.
    • Derive GridGroupingControl and override the virtual CreateEngine method.

    In your derived engine class, you can then further customize classes that are created. The GridEngine class contains virtual factory methods such as CreateTableControl(GridTableModel) or CreateTable(TableDescriptor, Table) that are called to create objects that belong to a GridGroupingControl and its engine elements.

    Constructors

    GridEngineFactoryBase()

    Initializes a new instance of the GridEngineFactoryBase class.

    Declaration
    public GridEngineFactoryBase()

    GridEngineFactoryBase(Boolean)

    Initializes a GridEngineFactoryBase and optionally marks it as "Default".

    Declaration
    public GridEngineFactoryBase(bool isDefault)
    Parameters
    Type Name Description
    System.Boolean isDefault

    True if this engine should be marked as default.

    Properties

    IsDefault

    Gets the value as True when this factory has been auto-initialized.

    Declaration
    public virtual bool IsDefault { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    CreateEngine()

    Override this method if you would like to have a derived engine object. The method is called from CreateEngine() to create a default engine object when no engine objects were manually instantiated. See also the discussion in GridEngineFactory.

    Declaration
    public virtual GridEngine CreateEngine()
    Returns
    Type Description
    GridEngine

    The new grid engine.

    See Also

    GridGroupingControl
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved