Version

SaveAsXml(String,PropertyCategories) Method

Saves a layout to a file, using the specified property categories.
Syntax
'Declaration
 
Public Overloads Sub SaveAsXml( _
   ByVal filename As String, _
   ByVal propertyCategories As PropertyCategories _
) 
public void SaveAsXml( 
   string filename,
   PropertyCategories propertyCategories
)

Parameters

filename
The name of the file to write.
propertyCategories
Identifies which property categories to save.
Remarks

Invoking this method saves a layout to a file.

Invoke the LoadFromXml(String,PropertyCategories) method to restore the saved layout.

When specifying 256 (PropCatGeneral), the following property settings for the UltraGridLayout object are saved:

  • AddNewBox
  • AlphaBlendEnabled
  • BorderStyle
  • BorderStyleCaption
  • Caption
  • Enabled
  • EstimatedRows
  • Font
  • InterBandSpacing
  • MaxColScrollRegions
  • MaxRowScrollRegions
  • Override
  • RowConnectorColor
  • RowConnectorStyle
  • ScrollBars
  • TabNavigation
  • TagVariant
  • ViewStyle
  • ViewStyleBand

Multiple Layout categories can be saved by combining them using logical Or.

The Clone and CopyFrom methods can be invoked to make a duplicate of a layout.

Example
Following code shows you how to save and load the saved layout using overloads of SaveAsXML and LoadFromXML methods that take in a file name.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

    Private Sub UltraGrid1_InitializeLayout(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs) Handles UltraGrid1.InitializeLayout
        ' Setup the layout.
        e.Layout.Override.CellAppearance.BackColor = Color.LightYellow
        e.Layout.ViewStyleBand = ViewStyleBand.OutlookGroupBy
    End Sub

    Private Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button1.Click
        ' Save the layout to a file.
        Me.UltraGrid1.DisplayLayout.SaveAsXml("c:\\test.xml")
    End Sub

    Private Sub Button2_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button2.Click
        ' Reset the layout.
        Me.UltraGrid1.DisplayLayout.Reset()
    End Sub

    Private Sub Button3_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button3.Click
        ' Load the saved layout.
        Me.UltraGrid1.DisplayLayout.LoadFromXml("c:\\test.xml")
    End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

		private void ultraGrid1_InitializeLayout(object sender, Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs e)
		{
			// Setup the layout.
			e.Layout.Override.CellAppearance.BackColor = Color.LightYellow;
			e.Layout.ViewStyleBand = ViewStyleBand.OutlookGroupBy;
		}

		private void button1_Click(object sender, System.EventArgs e)
		{
			// Save the layout to a file.
			this.ultraGrid1.DisplayLayout.SaveAsXml( "c:\\test.xml" );
		}

		private void button2_Click(object sender, System.EventArgs e)
		{
			// Reset the layout.
			this.ultraGrid1.DisplayLayout.Reset( );
		}

		private void button3_Click(object sender, System.EventArgs e)
		{
			// Load the saved layout.
			this.ultraGrid1.DisplayLayout.LoadFromXml( "c:\\test.xml" );
		}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also