GroupPolicyExtension Class

Article
10/10/2016

The abstract base class that represents a Group Policy Object Editor extension.

Namespace: Microsoft.GroupPolicy
Assembly: Microsoft.GroupPolicy.Management (in Microsoft.GroupPolicy.Management.dll)

Inheritance Hierarchy

System.Object
Microsoft.GroupPolicy.GroupPolicyExtension
Microsoft.GroupPolicy.PreferenceExtension
Microsoft.GroupPolicy.RegistryPolicy

Syntax

public abstract class GroupPolicyExtension : IDisposable

public ref class GroupPolicyExtension abstract : IDisposable

[<AbstractClass>]
type GroupPolicyExtension = 
    class
        interface IDisposable
    end

Public MustInherit Class GroupPolicyExtension
    Implements IDisposable

Constructors

	Name	Description
	GroupPolicyExtension(DirectoryContext, Guid)	Initializes a new instance of the GroupPolicyExtension class by using the specified DirectoryContext and the specified Group Policy object (GPO) ID (GUID).
	GroupPolicyExtension(DirectoryContext, String)	Initializes a new instance of the GroupPolicyExtension class by using the specified DirectoryContext and the display name of the Group Policy object (GPO).
	GroupPolicyExtension(Domain, Guid)	Initializes a new instance of the GroupPolicyExtension class by using the specified Domain and the specified Group Policy object (GPO) ID (GUID).
	GroupPolicyExtension(Domain, String)	Initializes a new instance of the GroupPolicyExtension class by using the specified Domain and the display name of the Group Policy object (GPO).
	GroupPolicyExtension(DomainController, Guid)	Initializes a new instance of the GroupPolicyExtension class by using the specified DomainController and the specified Group Policy object (GPO) ID (GUID).
	GroupPolicyExtension(DomainController, String)	Initializes a new instance of the GroupPolicyExtension class by using the specified DomainController and the display name of the Group Policy object (GPO).

Properties

	Name	Description
	ClientSideExtensionGuid	When implemented in a derived class, gets the GUID of the client-side extension.
	ComputerEditorGuid	When implemented in a derived class, gets the GUID of the editor that is used to edit Group Policy settings in the computer section of the Group Policy object (GPO).
	Domain	Gets the domain for the Group Policy object (GPO).
	DomainController	Gets domain controller on which the Group Policy object (GPO) is being edited.
	Gpo	Gets the underlying GroupPolicyObject that represents the GPO being edited.
	GpoDisplayName	Gets the display name of the Group Policy object (GPO) that is being edited.
	GpoId	Gets the ID (GUID) of the Group Policy object (GPO).
	GpoPath	Gets the distinguished name of the Group Policy object (GPO).
	IsOpened	Gets a value that indicates whether the GPO has been opened.
	IsReadOnly	Gets a value that indicates whether the Group Policy object (GPO) is opened in read-only mode.
	UserEditorGuid	When implemented in a derived class, gets the GUID of the editor that is used to edit Group Policy settings in the user section of the Group Policy object (GPO).

Methods

	Name	Description
	Dispose()	Releases all resources used by the current instance of the GroupPolicyExtension class.
	Dispose(Boolean)	Releases the unmanaged resources used by the GroupPolicyExtension class and optionally releases the managed resources.
	Equals(Object)	(Inherited from Object.)
	EscapeStringForLdap(String)
	Finalize()	Allows a GroupPolicyExtension object to attempt to free resources and perform other cleanup operations before the object is reclaimed by garbage collection.(Overrides Object.Finalize().)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsDefaultValueName(String)	This method is for internal use only. Do not use it in your code.
	MemberwiseClone()	(Inherited from Object.)
	OnOpened(EventArgs)	Called by the OpenGpo method to allow for post-processing by the derived class.
	OnOpening(EventArgs)	Called by the OpenGpo method to allow for pre-processing by the derived class.
	OnSaved(EventArgs)	Called by the Save method after the save has been performed, to allow for post-processing by the derived class.
	OnSaving(SavingEventArgs)	Called by the Save method before the save is performed, to allow for pre-processing by the derived class.
	OpenGpo(Boolean)	Opens the Group Policy object (GPO) according to the specified value for read only.
	OpenGpo(Boolean, Boolean)	Opens the Group Policy object (GPO) according to the specified value for read only and optionally loads the registry.
	Save(Boolean)	Saves the specified Group Policy object (GPO) section for the GPO.
	ToString()	(Inherited from Object.)

Fields

	Name	Description
	defaultValueNameConstant	This field is for internal use only. Do not use it in your code.

Remarks

The following classes derive from this class:

RegistryPolicy represents the Group Policy Object Editor extension that can be used to create, modify, and delete registry-based policy settings.
PreferenceExtension represents the Group Policy Object Editor extension that can be used to create, modify, and delete Registry preference items.

You can derive from this class to create classes that represent other Group Policy Object Editor extensions.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.