3rdpartylibs/fastreports/Fast-Report/FastReport.Base/Data/DataComponentBase.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel;
using FastReport.Utils;

namespace FastReport.Data
{
  /// <summary>
  /// The base class for all data components such as data sources, columns.
  /// </summary>
  public partial class DataComponentBase : Base
  {
    #region Fields
    private string alias;
    private bool enabled;
    private string referenceName;
    private object reference;
    #endregion

    #region Properties
    /// <summary>
    /// Gets or sets alias of this object.
    /// </summary>
    /// <remarks>
    /// Alias is a human-friendly name of this object. It may contain any symbols (including 
    /// spaces and national symbols).
    /// </remarks>
    [Category("Design")]
    public new string Alias
    {
      get { return alias; }
      set { alias = value; }
    }

    /// <summary>
    /// Gets or sets a value indicates that object is enabled and thus can be used in a report.
    /// </summary>
    /// <remarks>
    /// This property is used to hide an object from the Data Dictionary window. Hidden
    /// objects are still accessible in the "Data|Choose Data Source..." menu.
    /// </remarks>
    [Browsable(false)]
    public bool Enabled
    {
      get { return enabled; }
      set { enabled = value; }
    }
    
    /// <summary>
    /// Gets or sets a name of the data object.
    /// </summary>
    /// <remarks>
    /// This property is used to support FastReport.Net infrastructure. Do not use it directly.
    /// </remarks>
    [Browsable(false)]
    public string ReferenceName
    {
      get { return referenceName; }
      set { referenceName = value; }
    }

    /// <summary>
    /// Gets or sets a reference to the data object.
    /// </summary>
    /// <remarks>
    /// This property is used to support FastReport.Net infrastructure. Do not use it directly.
    /// </remarks>
    [Browsable(false)]
    public object Reference
    {
      get { return reference; }
      set { reference = value; }
    }

    /// <summary>
    /// Gets a value indicates that this object has an alias.
    /// </summary>
    [Browsable(false)]
    public bool IsAliased
    {
      get { return Name != Alias; }
    }
    #endregion

    #region Public Methods
    /// <inheritdoc/>
    public override void Assign(Base source)
    {
      BaseAssign(source);
    }

    /// <inheritdoc/>
    public override void SetName(string value)
    {
      bool changeAlias = String.IsNullOrEmpty(Alias) || String.Compare(Alias, Name, true) == 0;
      base.SetName(value);
      if (changeAlias)
        Alias = Name;
    }

    /// <inheritdoc/>
    public override void Serialize(FRWriter writer)
    {
      base.Serialize(writer);
      if (IsAliased)
        writer.WriteStr("Alias", Alias);
      if (!Enabled)
        writer.WriteBool("Enabled", Enabled);
      if (!String.IsNullOrEmpty(ReferenceName))
        writer.WriteStr("ReferenceName", ReferenceName);
    }

    /// <summary>
    /// Initializes the object before running a report.
    /// </summary>
    /// <remarks>
    /// This method is used by the report engine, do not call it directly.
    /// </remarks>
    public virtual void InitializeComponent()
    {
    }
    #endregion

    /// <summary>
    /// Initializes a new instance of the <see cref="DataComponentBase"/> class with default settings.
    /// </summary>
    public DataComponentBase()
    {
      Alias = "";
      ReferenceName = "";
      Enabled = true;
      SetFlags(Flags.CanEdit | Flags.CanCopy, false);
    }
  }
}