StringFormatMethodAttribute Class

Couchbase .NET SDK 2.0

Indicates that the marked method builds string by format pattern and (optional) arguments. Parameter, which contains format string, should be given in constructor. The format string should be in Format(IFormatProvider, String,Object[])-like form

Inheritance Hierarchy

System.Object
System.Attribute
Couchbase.Annotations.StringFormatMethodAttribute

Namespace: Couchbase.Annotations
Assembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

C++

Copy to Clipboard Print

public sealed class StringFormatMethodAttribute : Attribute

public sealed class StringFormatMethodAttribute : Attribute

Public NotInheritable Class StringFormatMethodAttribute 
	Inherits Attribute

Public NotInheritable Class StringFormatMethodAttribute 
	Inherits Attribute

public ref class StringFormatMethodAttribute sealed : public Attribute

public ref class StringFormatMethodAttribute sealed : public Attribute

[<SealedAttribute>]
type StringFormatMethodAttribute =  
    class 
        inherit Attribute 
    end

[<SealedAttribute>]
type StringFormatMethodAttribute =  
    class 
        inherit Attribute 
    end

The StringFormatMethodAttribute type exposes the following members.

Constructors

	Name	Description
	StringFormatMethodAttribute	Initializes a new instance of the StringFormatMethodAttribute class

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	FormatParameterName
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Examples

Copy to Clipboard Print

[StringFormatMethod("message")]
public void ShowError(string message, params object[] args) { /* do something */ }
public void Foo() {
  ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}

[StringFormatMethod("message")]
public void ShowError(string message, params object[] args) { /* do something */ }
public void Foo() {
  ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
}

Reference

Couchbase.Annotations Namespace