Share via


RefactoringPreviewGroup Class

Captures check-box settings, friendly name, and other information for a preview group. A RefactoringPreviewGroup contains only group information, and does not contain the list of changes. The contributor class of the operation contains RefactoringPreviewGroup and a list of changes. For more information, see Create Custom Database Refactoring Types or Targets.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Schema.Package.Refactoring.RefactoringPreviewGroup

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.Refactoring
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
Public NotInheritable Class RefactoringPreviewGroup
public sealed class RefactoringPreviewGroup
public ref class RefactoringPreviewGroup sealed
[<Sealed>]
type RefactoringPreviewGroup =  class end
public final class RefactoringPreviewGroup

The RefactoringPreviewGroup type exposes the following members.

Constructors

  Name Description
Public method RefactoringPreviewGroup Initializes a new instance of the RefactoringPreviewGroup class.

Top

Properties

  Name Description
Public property DefaultChecked Gets or sets a value that indicates whether all changes within this preview group are selected by default.
Public property Description Gets or sets the description for the group node that will be used in the tooltip.
Public property EnableChangeGroupUncheck Gets or sets a value that indicates whether this group will have a check box for the user to select or clear this group of changes.
Public property EnableChangeUncheck Gets or sets a value that indicates whether individual changes within this preview group can be selected.
Public property IncludeInCurrentProject Gets or sets a value that indicates whether this preview group appears in the startup project node, independent of whether it has one or more changes.
Public property Name Gets the friendly name for the group node.
Public property WarningMessage Gets or sets the warning message that informs the user of the expected results after the changes for this group are applied.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic member RegisterIcon Registers the icon image to use for preview nodes for the specified file name extension.
Public method RegisterLanguageService Registers a language service for a specified file name extension.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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.

See Also

Reference

Microsoft.VisualStudio.Data.Schema.Package.Refactoring Namespace