DistributionArticle Class

Represents information about an article published in a transactional or snapshot publication stored at the Distributor.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.DistributionArticle

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public NotInheritable Class DistributionArticle _
    Inherits ReplicationObject
'Usage
Dim instance As DistributionArticle

public sealed class DistributionArticle : ReplicationObject

public ref class DistributionArticle sealed : public ReplicationObject

[<SealedAttribute>]
type DistributionArticle =  
    class 
        inherit ReplicationObject 
    end

public final class DistributionArticle extends ReplicationObject

The DistributionArticle type exposes the following members.

Constructors

	Name	Description
	DistributionArticle()	Creates a new instance of the DistributionArticle class.
	DistributionArticle(String, String, String, String, String, ServerConnection)	Creates a new instance of the DistributionArticle class with the required properties and a connection to the Distributor.

Top

Properties

	Name	Description
	ArticleId	Gets or sets the ID value for the article.
	CachePropertyChanges	Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
	ConnectionContext	Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
	Description	Gets or sets a description for the article.
	DistributionDBName	Gets or sets the name of the distribution database that contains the article metadata.
	IsExistingObject	Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
	Name	Gets or sets the name of the article.
	PublicationDBName	Gets or sets the name of the publication database.
	PublicationName	Gets or sets the name of the publication that contains the article.
	PublisherName	Gets or sets the name of the Publisher.
	SourceObjectName	Gets or sets the database object that provides the article data.
	SourceObjectOwner	Gets or sets the owner of the database object that provides the article data.
	SqlServerName	Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
	UserData	Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

	Name	Description
	CommitPropertyChanges	Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
	Create	Creates the article metadata at the Distributor.
	Decouple	Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Load	Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
	LoadProperties	Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
	Refresh	Reloads the properties of the object. (Inherited from ReplicationObject.)
	Remove	Removes article metadata from the Distributor.
	Script	Generates a Transact-SQL script that can be used to create or delete the article with the specified properties.
	ToString	(Inherited from Object.)

Top

Remarks

The DistributionArticle class is used primarily by SQL Server Management Studio and for non-SQL Server Publishers. To create, view, or modify the properties of an article, you should instead use an instance of the TransArticle class.

The DistributionArticle class requires a connection to the Distributor.

Thread Safety

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

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.Replication Namespace