ModuleListPage Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a class that is derived from the ModulePage class and supports searching, filtering, and group modes.
public ref class ModuleListPage abstract : Microsoft::Web::Management::Client::Win32::ModulePagepublic abstract class ModuleListPage : Microsoft.Web.Management.Client.Win32.ModulePagetype ModuleListPage = class
inherit ModulePagePublic MustInherit Class ModuleListPage
Inherits ModulePage- Inheritance
Remarks
This is the base class for list-based pages such as sites and applications. Use this class to display a list of items. IIS Manager uses this base class for the Application Settings, Modules, Worker Processes, and Web Sites pages.
Constructors
| ModuleListPage() |
Initializes a new instance of the ModuleListPage class. |
| ModuleListPage(ListPageListView) |
Initializes a new instance of the ModuleListPage class by using the specified list view. |
Fields
| EmptyGrouping |
A ModuleListPageGrouping object that signifies no grouping. |
Properties
| CanRefresh |
Gets a value indicating whether the page supports refreshing. (Inherited from ModulePage) |
| CanSearch |
Gets a value indicating whether a page can be searched. |
| Connection |
Gets the associated connection. (Inherited from ModulePage) |
| ContextMenuStrip |
Gets or sets the shortcut menu for the page. (Inherited from ModulePage) |
| CreateParams |
Gets creation parameters for the page. (Inherited from ModulePage) |
| DefaultGrouping |
Gets the default grouping. |
| DefaultViewMode |
Gets the default view mode. |
| Filter |
Gets the filter for the page. |
| Groupings |
Gets the groupings for the page. |
| HasChanges |
Gets a value indicating whether the ModulePage object has changes. (Inherited from ModulePage) |
| InProgress |
Gets a value indicating whether the progress bar has been started. (Inherited from ModulePage) |
| LargeImageList |
Gets the list of large images. |
| ListView |
Gets the list view. |
| ListViewContainer |
Gets the list view container. |
| Margin |
Gets the default padding. (Inherited from ModulePage) |
| Module |
Gets the module for the page. (Inherited from ModulePage) |
| PageInfo |
Gets the ModulePageInfo object for the page. (Inherited from ModulePage) |
| PreferenceKey |
Gets the identifier that is used in the preference store. (Inherited from ModulePage) |
| ReadOnly |
Gets the current delegation mode for the page. (Inherited from ModulePage) |
| ReadOnlyDescription |
Gets the description that is used when the delegation state is ReadOnlyDelegationState. (Inherited from ModulePage) |
| RightToLeftLayout |
Gets or sets a value indicating whether right-to-left mirror placement is turned on. (Inherited from ModulePage) |
| ScopeStatusSummary |
Gets additional information to show in the status bar. (Inherited from ModulePage) |
| SearchFields |
Gets the searchable columns for the list view. |
| SelectedGrouping |
Get or sets the list view grouping. |
| ServiceProvider |
Gets the service provider for the Module object. (Inherited from ModulePage) |
| ShowTaskList | (Inherited from ModulePage) |
| SmallImageList |
Gets the list of small images. |
| SortColumn |
Gets the header of the sort column. |
| SortOrder |
Gets the sort order for the selected column. |
| Tasks |
Gets the list of tasks for the page. (Inherited from ModulePage) |
| ViewModes |
Gets the supported view modes. |
Methods
| ClearFilter() |
Clears the filter. |
| CreateProxy(Type) |
Retrieves the service proxy for the page. (Inherited from ModulePage) |
| DisplayErrorMessage(Exception, ResourceManager) |
Displays a modal dialog box with an error message, based on the specified exception and resource manager. (Inherited from ModulePage) |
| DisplayErrorMessage(Exception, ResourceManager, String) |
Displays a modal dialog box with an error message, based on the specified exception, resource manager, and caption. (Inherited from ModulePage) |
| DisplayErrorMessage(String, String) |
Displays a modal dialog box with an error message, based on the specified error text and error message. (Inherited from ModulePage) |
| DisplayErrorMessage(String, String, String) |
Displays a modal dialog box with an error message, based on the specified error text, error message, and caption. (Inherited from ModulePage) |
| Dispose(Boolean) | |
| EditProperties(IPropertyEditingUser, Object, String, String) |
Launches a user interface (UI) to edit the properties of the specified object. (Inherited from ModulePage) |
| EditProperties(IPropertyEditingUser, Object, String, String, EventHandler) |
Launches a user interface (UI) to edit the properties of the specified object, based on the specified event handler. (Inherited from ModulePage) |
| GetGroups(ModuleListPageGrouping) |
Gets the supported groupings. |
| GetItemComparer(ColumnHeader, SortOrder) |
Gets an object that compares two columns. |
| GetPageType(String) |
Retrieves the page type that is associated with the module page. (Inherited from ModulePage) |
| GetService(Type) |
Retrieves the requested service object. (Inherited from ModulePage) |
| Group(ModuleListPageGrouping) |
Displays configuration features by the specified grouping. |
| Initialize(Object) |
Initializes the page when it is first created. (Inherited from ModulePage) |
| InitializeListPage() |
When overridden in a derived class, initializes the list view for the page. |
| LoadPreferences(PreferencesStore) |
Retrieves stored preferences from a per-user store. |
| Navigate(Type) |
Navigates to the target page. (Inherited from ModulePage) |
| Navigate(Type, Object) |
Navigates to the target page with a payload. (Inherited from ModulePage) |
| OnActivated(Boolean) |
Indicates that a page is displayed in IIS Manager. |
| OnClearFilter() |
When implemented in a derived class, clears the ModuleListPageFilter object. |
| OnDeactivating(CancelEventArgs) |
Provides a mechanism to cancel the page view change. (Inherited from ModulePage) |
| OnGroup(ModuleListPageGrouping) |
Indicates that a group is selected. |
| OnSearch(ModuleListPageSearchOptions) |
When overridden in a derived class, performs a search. |
| OnSetView() |
When overridden in a derived class, updates the view. |
| Refresh() |
Indicates that the page needs to be refreshed. (Inherited from ModulePage) |
| RefreshFilter() |
Updates the page by using the Filter property data. |
| RefreshSearchPanel() |
Updates the search fields on the page. |
| SavePreferences(PreferencesStore) |
Saves the page grouping, sort order, search entries, and layout. |
| SetView(ModuleListPageViewModes) |
Sets the view mode. |
| ShowDialog(DialogForm) |
Displays a dialog box that is parented to the top-most window. (Inherited from ModulePage) |
| ShowError(Exception, Boolean) |
Displays an error message box that is parented to the top-most window, using the specified exception and warning status. (Inherited from ModulePage) |
| ShowError(Exception, String, Boolean) |
Displays an error message box that is parented to the top-most window, using the specified exception, message, and warning status. (Inherited from ModulePage) |
| ShowError(Exception, String, Boolean, String) |
Displays an error message box that is parented to the top-most window, using the specified exception, message, warning status, and caption. (Inherited from ModulePage) |
| ShowError(String, Boolean) |
Displays an error message box that is parented to the top-most window, using the specified message and warning status. (Inherited from ModulePage) |
| ShowHelp() |
Indicates whether a Help dialog box is available. (Inherited from ModulePage) |
| ShowMessage(String) |
Displays a message box that is parented to the top-most window, using the specified text. (Inherited from ModulePage) |
| ShowMessage(String, MessageBoxButtons, MessageBoxIcon) |
Displays a message box that is parented to the top-most window, using the specified text, button set, and icon. (Inherited from ModulePage) |
| ShowMessage(String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton) |
Displays a message box that is parented to the top-most window, using the specified text, button set, icon, and default button. (Inherited from ModulePage) |
| ShowMessage(String, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton, String) |
Displays a message box that is parented to the top-most window, using the specified text, button set, icon, default button, and caption. (Inherited from ModulePage) |
| ShowMessage(String, MessageBoxButtons, MessageBoxIcon, String) |
Displays a message box that is parented to the top-most window, using the specified text, button set, icon, and caption. (Inherited from ModulePage) |
| ShowMessage(String, String) |
Displays a message box that is parented to the top-most window, using the specified text and caption. (Inherited from ModulePage) |
| ShowOnlineHelp() |
Returns a value indicating whether online Help is available. (Inherited from ModulePage) |
| Sort() |
Sorts the data that is displayed in the list view by using the current sort column and sort order. |
| Sort(ColumnHeader, SortOrder) |
Sorts the list view by using the specified sort column and sort order. |
| StartAsyncTask(String, DoWorkEventHandler, RunWorkerCompletedEventHandler) |
Starts the task by using a worker thread, based on the specified progress text and handlers for work and completion. (Inherited from ModulePage) |
| StartAsyncTask(String, DoWorkEventHandler, RunWorkerCompletedEventHandler, MethodInvoker) |
Starts the task by using a worker thread, based on the specified progress text and handlers for work, completion, and cancellation. (Inherited from ModulePage) |
| StartAsyncTask(String, DoWorkEventHandler, RunWorkerCompletedEventHandler, MethodInvoker, Object) |
Starts the task by using a worker thread, based on the specified progress text, argument object, and handlers for work, completion, and cancellation. (Inherited from ModulePage) |
| StartProgress(String, MethodInvoker) |
Starts the progress indicator. (Inherited from ModulePage) |
| StopProgress() |
Stops the progress indicator. (Inherited from ModulePage) |
| Update() |
Updates the tasks and the user interface (UI). (Inherited from ModulePage) |
Explicit Interface Implementations
| IDisposable.Dispose() |
Calls the Dispose(Boolean) method. (Inherited from ModulePage) |
| IModulePage.CanRefresh | (Inherited from ModulePage) |
| IModulePage.HasChanges | (Inherited from ModulePage) |
| IModulePage.Initialize(Module, ModulePageInfo, Object) |
Initializes the ModulePage object. (Inherited from ModulePage) |
| IModulePage.OnActivated(Boolean) |
Indicates that the page has been activated. (Inherited from ModulePage) |
| IModulePage.OnDeactivating(CancelEventArgs) |
Calls the OnDeactivating(CancelEventArgs) method. (Inherited from ModulePage) |
| IModulePage.PageInfo | (Inherited from ModulePage) |
| IModulePage.Refresh() |
Calls the Refresh() method. (Inherited from ModulePage) |
| IModulePage.ShowHelp() |
Calls the ShowHelp() method. (Inherited from ModulePage) |
| IModulePage.Tasks | (Inherited from ModulePage) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for