Infragistics(R) NetAdvantage(R) Windows Forms
SpecialBoxBase Class
Members  Example  See Also  E-mail your feedback on this topic.
Infragistics.Win.UltraWinGrid Namespace : SpecialBoxBase Class

Returns a reference to the SpecialBoxBase object. This property is read-only at design-time and run-time.

Syntax

Visual Basic (Declaration) 
Public MustInherit Class SpecialBoxBase 
   Inherits Infragistics.Shared.SubObjectBase
C# 
public abstract class SpecialBoxBase : Infragistics.Shared.SubObjectBase 

Example

Following code configures the look of add-new-box in the ultragrid. Add-new-box allows easy adding of rows by clicking on add new buttons in it. Each add new button in add-new-box corresponds to a band in the ultragrid.

Visual BasicCopy Code
Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button3_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button3.Click

      ' Make the addnew box visible.
      Me.UltraGrid1.DisplayLayout.AddNewBox.Hidden = False

      ' Change the prompt on the add new box.
      Me.UltraGrid1.DisplayLayout.AddNewBox.Prompt = "Add a new row"

      ' Make the add new box compact to save space.
      Me.UltraGrid1.DisplayLayout.AddNewBox.Style = AddNewBoxStyle.Compact

      ' Set the back color of the add new box area and set the border style to etched.
      Me.UltraGrid1.DisplayLayout.AddNewBox.Appearance.BackColor = Color.White
      Me.UltraGrid1.DisplayLayout.AddNewBox.BorderStyle = UIElementBorderStyle.Etched

      ' Configure the way button connectors look
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonConnectorStyle = UIElementBorderStyle.Etched
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonConnectorColor = Color.Red

      ' Configure the way buttons look.
      ' Set the buttons' style to PopupSoft and set the appearance of the buttons.
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonStyle = UIElementButtonStyle.PopupSoft
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackColor = Color.SkyBlue
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackColor2 = Color.Blue
      Me.UltraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackGradientStyle = GradientStyle.Horizontal

      ' You can also customize the caption of the buttons that show up in the add-new-box.
      ' Each band has a button in the add-new-box. You can change the caption of these
      ' buttons by setting the AddButtonCaption property off the bands. You can also set
      ' the tool-tip text for those buttons as well by setting AddButtonToolTipText property.
      Me.UltraGrid1.DisplayLayout.Bands("Customers").AddButtonCaption = "New Customer"
      Me.UltraGrid1.DisplayLayout.Bands("Customers").AddButtonToolTipText = "Click to add a new Customers record."

  End Sub
C#Copy Code
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button3_Click(object sender, System.EventArgs e)
{

	// Make the addnew box visible.
	this.ultraGrid1.DisplayLayout.AddNewBox.Hidden = false;

	// Change the prompt on the add new box.
	this.ultraGrid1.DisplayLayout.AddNewBox.Prompt = "Add a new row";
          
	// Make the add new box compact to save space.
	this.ultraGrid1.DisplayLayout.AddNewBox.Style = AddNewBoxStyle.Compact;
	
	// Set the back color of the add new box area and set the border style to etched.
	this.ultraGrid1.DisplayLayout.AddNewBox.Appearance.BackColor = Color.White;
	this.ultraGrid1.DisplayLayout.AddNewBox.BorderStyle = UIElementBorderStyle.Etched;

	// Configure the way button connectors look
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonConnectorStyle = UIElementBorderStyle.Etched;
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonConnectorColor = Color.Red;
	
	// Configure the way buttons look.
	// Set the buttons' style to PopupSoft and set the appearance of the buttons.
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonStyle = UIElementButtonStyle.PopupSoft;
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackColor = Color.SkyBlue;
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackColor2 = Color.Blue;
	this.ultraGrid1.DisplayLayout.AddNewBox.ButtonAppearance.BackGradientStyle = GradientStyle.Horizontal;

	// You can also customize the caption of the buttons that show up in the add-new-box.
	// Each band has a button in the add-new-box. You can change the caption of these
	// buttons by setting the AddButtonCaption property off the bands. You can also set
	// the tool-tip text for those buttons as well by setting AddButtonToolTipText property.
	this.ultraGrid1.DisplayLayout.Bands["Customers"].AddButtonCaption = "New Customer";
	this.ultraGrid1.DisplayLayout.Bands["Customers"].AddButtonToolTipText = "Click to add a new Customers record.";

}

Remarks

This property returns a reference to an SpecialBoxBase object that can be used to set properties of, and invoke methods on, the AddNew box. You can use this reference to access any of the AddNew box's properties or methods.

Use the returned reference to show or hide the AddNew box or adjust its or its buttons' appearance.

See Also