ProfileOptionsExtension Class

public abstract class ProfileOptionsExtension : IExtensionInterface

Public MustInherit Class ProfileOptionsExtension
	Implements IExtensionInterface

// @AUTO-REFERENCE { [CT_INSTALL_PATH]\CTInterface.dll }
// @AUTO-REFERENCE { [CT_INSTALL_PATH]\Interop.CTEngineLib.dll }
// @AUTO-REFERENCE { C:\Windows\Microsoft.NET\Framework\v4.0.30319\System.Windows.Forms.dll }

using ATR.CT.CTInterface;
using CTExtensions;
using CTEngineLib;
using CTExtensions.Interfaces;
using System;
using System.Windows.Forms;

public class MyAddin : CTExtension
{

  private MyProfileSettingsPage moProfileSettingsPage;

  public override bool Hook(CTInterface oCTInterface)
  {
    return false; // We don't care about events.
  }

  public override void UnHook(CTInterface oCTInterface)
  {

  }

  /// <summary>
  /// Return the custom interface on request.
  /// </summary>
  public override IExtensionInterface GetInterface(ctExtensionInterface eType)
  {
    if (eType == ctExtensionInterface.ctExtensionInterfaceProfileSettings)
    {
      if (moProfileSettingsPage == null)
        moProfileSettingsPage = new MyProfileSettingsPage(this);
      return moProfileSettingsPage;
    }

    return null;
  }

  /// <summary>
  /// Create custom implementation for ProfileOptionsExtension.
  /// </summary>
  class MyProfileSettingsPage : ProfileOptionsExtension
  {

    private MyAddin moParent;
    private Panel moMyControl;
    private TextBox MyTextBox;

    public MyProfileSettingsPage(MyAddin oParent)
    {
      moParent = oParent;
    }

    public override ICTExtension GetParent()
    {
      return moParent;
    }

    /// <summary>
    /// Create panel with label and text field.
    /// </summary>
    /// <returns></returns>
    public override Control CreateControl()
    {
      moMyControl = new Panel();
      MyTextBox = new TextBox() { Dock = DockStyle.Top };

      moMyControl.Controls.Add(MyTextBox);
      moMyControl.Controls.Add(new Label() { Text = "My control", Dock = DockStyle.Top });
      return moMyControl;
    }

    /// <summary>
    /// Return the data we want to save.
    /// </summary>
    /// <param name="bCancelSave">Return false here.</param>
    public override byte[] GetSaveData(out bool bCancelSave)
    {
      bCancelSave = false;
      return System.Text.Encoding.UTF8.GetBytes(MyTextBox.Text);
    }

    /// <summary>
    /// Load the previously saved data for the control if any.
    /// </summary>
    /// <param name="storedData"></param>
    public override void LoadData(byte[] storedData)
    {
      try
      {
        MyTextBox.Text = System.Text.Encoding.UTF8.GetString(storedData);
      }
      catch
      {
        MyTextBox.Text = "";
      }
    }

    /// <summary>
    /// Must implement, but we can just return true here.
    /// </summary>
    /// <returns></returns>
    public override bool Refresh()
    {
      return true;
    }

    /// <summary>
    /// Validate the values before allowing user to exit. This function requires that the text box value must be either 'hello' or 'world'.
    /// </summary>
    /// <returns>True if data is valid, false otherwise.</returns>
    public override bool Validate()
    {
      if (String.Compare(MyTextBox.Text, "hello", true) != 0 && String.Compare(MyTextBox.Text, "world", true) != 0)
      {
        MessageBox.Show("You should type either 'hello' or 'world' to My control", "Error", MessageBoxButtons.OK, MessageBoxIcon.Hand);
        return false;
      }

      return true;
    }
  }

}