Share via

MSPropShell.RemoveAllPages

  • Article
Windows Media Encoder SDK banner art

The RemoveAllPages method removes all of the property pages from the MSPropShell control.

Syntax

void MSPropShell.RemoveAllPages();

Parameters

This method takes no parameters.

Return Values

This method does not return a value.

Remarks

Use this method to delete or reorder property pages. When all of the pages have been deleted, reorder them by calling MSPropShell.AddPage multiple times in the correct sequence. To avoid automatically refreshing after every page is added, set MSPropShell.AutoRefresh to false

To use the MSPropShell control, you must add the Microsoft PropShell Control 1.0 reference to the project, and add the MS PropShell Ctrl Class component to the Toolbox. For more information, see Programming in C#.

Example Code

using WMEncoderLib;
using MSPROPSHELLLib;

try
{
// Create a WMEncoder object.
WMEncoder Encoder;
Encoder = new WMEncoder();

// Create the Windows Media Encoder property pages.
WMEncSourcesPage PpgSources = new WMEncSourcesPage();
WMEncDisplayInfoPage PpgDesc = new WMEncDisplayInfoPage();
WMEncAttributesPage PpgAttr = new WMEncAttributesPage();
WMEncProfilePage PpgProfile = new WMEncProfilePage();
WMEncOutputPage PpgOutput = new WMEncOutputPage();

// Add Windows Media Encoder to the property page shell.
// You must add the encoder before adding the property pages.
PropPageShell.AddObject(Encoder);

// Add the property pages to the property page shell. To create an
// MSPropShell ActiveX control, on the Project menu, click Components,
// and then in the Components dialog box, select Microsoft PropShell
// Control 1.0. In the following example, the ActiveX control is named
// PropPageShell.
PropPageShell.AddPage(PpgSources);
PropPageShell.AddPage(PpgDesc);
PropPageShell.AddPage(PpgAttr);
PropPageShell.AddPage(PpgProfile);
PropPageShell.AddPage(PpgOutput);

// Reorder the pages. Call RemoveAllPages to remove all
// property pages from the MSPropShell control.
PropPageShell.RemoveAllPages();

// Set the AutoRefresh property to false so that the
// MSPropShell control is not refreshed when each new page is added.
PropPageShell.AutoRefresh = false;

// Add the property pages in the desired order.
PropPageShell.AddPage(PpgOutput);
PropPageShell.AddPage(PpgAttr);
PropPageShell.AddPage(PpgProfile);
PropPageShell.AddPage(PpgSources);
PropPageShell.AddPage(PpgDesc);

// Refresh the MSPropShell ActiveX control.
PropPageShell.Refresh();
}

catch (Exception e)
{
     // TODO: Handle exceptions.
}

Requirements

Reference: Microsoft PropShell Control 1.0

Namespace: MSPropShellLib

Assembly: Interop.MSPropShellLib.dll

Library: mspshell.dll

See Also