CatalogFolder Class

Represents the folder for the catalogs.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder

Namespace:  Microsoft.SqlServer.Management.IntegrationServices
Assembly:  Microsoft.SqlServer.Management.IntegrationServices (in Microsoft.SqlServer.Management.IntegrationServices.dll)

Syntax

'Declaration
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")> _
Public NotInheritable Class CatalogFolder _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,  _
    IRenamable, ISfcRenamable, ISfcDiscoverObject, ISfcDroppable, IDroppable
'Usage
Dim instance As CatalogFolder
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
public sealed class CatalogFolder : SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, IRenamable, 
    ISfcRenamable, ISfcDiscoverObject, ISfcDroppable, IDroppable
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
public ref class CatalogFolder sealed : public SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, IRenamable, 
    ISfcRenamable, ISfcDiscoverObject, ISfcDroppable, IDroppable
[<SealedAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")>]
type CatalogFolder =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcAlterable 
        interface IAlterable 
        interface IRenamable 
        interface ISfcRenamable 
        interface ISfcDiscoverObject 
        interface ISfcDroppable 
        interface IDroppable 
    end
public final class CatalogFolder extends SfcInstance implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, IRenamable, ISfcRenamable, ISfcDiscoverObject, ISfcDroppable, IDroppable

The CatalogFolder type exposes the following members.

Constructors

  Name Description
Public method CatalogFolder Initializes a new instance of the CatalogFolder class with the specified parent, name and description.

Top

Properties

  Name Description
Protected property AbstractIdentityKey (Inherited from SfcInstance.)
Public property Description Gets or sets the description of the CatalogFolder object.
Public property Environments Gets the environments in the folder.
Public property FolderId Gets the identifier of the folder.
Public property IdentityKey Gets the identity key.
Public property Metadata (Inherited from SfcInstance.)
Public property Name Gets or sets the name of the folder.
Public property Parent Gets or sets the parent.
Public property Projects Gets the projects in the folder.
Public property Properties (Inherited from SfcInstance.)
Protected property State (Inherited from SfcInstance.)
Public property Urn (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method Alter Alters the folder in the back-end server.
Public method Create Creates the folder in the back-end server.
Protected method CreateIdentityKey (Inherited from SfcInstance.)
Public method Deny Denies the permission to a specified user.
Public method DeployProject Deploys the project with the specified project name and project stream.
Public method Discover (Inherited from SfcInstance.)
Public method Drop Indicates the drop in the back-end server.
Public method Equals (Inherited from Object.)
Protected method GetChildCollection (Inherited from SfcInstance.)
Public method GetDomain (Inherited from SfcInstance.)
Public method GetEffectivePermissions Gets the effective permissions for the CatalogFolder object.
Public method GetExplicitPermissions() Gets the explicit permissions of the CatalogFolder object.
Public method GetExplicitPermissions(String) Gets the explicit permissions of the CatalogFolder object for a specified user.
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Gets the factory to create a new instance.
Public method GetPropertySet (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl (Inherited from SfcInstance.)
Public method Grant Grants permission to a specified user.
Protected method InitializeUIPropertyState (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges (Inherited from SfcInstance.)
Public method Refresh (Inherited from SfcInstance.)
Public method Rename Renames a folder.
Protected method ResetKey (Inherited from SfcInstance.)
Public method Revoke Revokes permission to a specified user.
Public method ScriptAlter Indicates the script to alter a folder.
Public method ScriptCreate Indicates the script to create a folder.
Public method ScriptDeny Indicates the script to deny the permission to a folder.
Public method ScriptDrop Indicates the script to drop a folder.
Public method ScriptGrant Indicates the script to grant the permission to a folder.
Public method ScriptRevoke Indicates the script to revoke the permission to a folder.
Public method Serialize (Inherited from SfcInstance.)
Public method ToString (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event PropertyChanged (Inherited from SfcInstance.)
Public event PropertyMetadataChanged (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcDiscoverObject.Discover Specifies whether to discover children and if their IsCrudActionHandledByParent is false (default), accumulate their CRUD scripts to my action script.
Explicit interface implemetationPrivate method ISfcRenamable.Rename Renames a folder.
Explicit interface implemetationPrivate method ISfcRenamable.ScriptRename Renames the script of a folder.

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.SqlServer.Management.IntegrationServices Namespace