Share via

MSPropShell.Refresh

  • Article
Windows Media Encoder SDK banner art

The Refresh method recreates all of the property pages in the MSPropShell control.

Syntax

void MSPropShell.Refresh();

Parameters

This method takes no parameters.

Return Values

This method does not return a value.

Remarks

The Refresh method destroys all of the property pages and recreates them. If you add a new WMEncoder object, call Refresh to rebuild the property pages. Alternatively, set the MSPropShell.AutoRefresh property to true to control this automatically.

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 Sources property page 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);

// Set the AutoRefresh property to false.
PropPageShell.AutoRefresh = false;

// Add the other property pages to the MSPropShell ActiveX
// control.
PropPageShell.AddPage(PpgProfile);
PropPageShell.AddPage(PpgOutput);

// 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