Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Primitives Namespace / StringAssertions<TAssertions> Class
In This Topic
    StringAssertions<TAssertions> Class
    In This Topic
    Contains a number of methods to assert that a System.String is in the expected state.
    Object Model
    StringAssertions<TAssertions> ClassAssertionChain Class
    Syntax
    [DebuggerNonUserCode()]
public class StringAssertions<TAssertions> : FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions> 
where TAssertions: StringAssertions<TAssertions>
    Type Parameters
    TAssertions
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Primitives.ReferenceTypeAssertions<TSubject,TAssertions>
          FluentAssertions.Primitives.StringAssertions<TAssertions>
             FluentAssertions.Primitives.StringAssertions

    Public Constructors
     NameDescription
    Public ConstructorStringAssertions<TAssertions> ConstructorInitializes a new instance of the StringAssertions<TAssertions> class.  
    Top
    Public Properties
     NameDescription
    Public PropertyCurrentAssertionChainProvides access to the FluentAssertions.Execution.AssertionChain that this assertion class was initialized with. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public PropertySubject Gets the object whose value is being asserted. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Top
    Protected Properties
     NameDescription
    Protected PropertyIdentifierOverridden.  Returns the type of the subject the assertion applies on. It should be a user-friendly name as it is included in the failure message. Returns the type of the subject the assertion applies on.  
    Top
    Public Methods
     NameDescription
    Public MethodBe Asserts that a string is exactly the same as another string, including the casing and any leading or trailing whitespace.  
    Public MethodBeAssignableToOverloaded. Asserts that the object is assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodBeEmptyAsserts that a string is System.String.Empty.  
    Public MethodBeEquivalentToOverloaded.  Asserts that a string is exactly the same as another string, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodBeLowerCasedAsserts that all cased characters in a string are lower-case. That is, that the string could be the result of a call to System.String.ToLowerInvariant,  
    Public MethodBeNull Asserts that the current object has not been initialized yet. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodBeNullOrEmptyAsserts that a string is either a null reference (Nothing in Visual Basic) or System.String.Empty.  
    Public MethodBeNullOrWhiteSpaceAsserts that a string is either a null reference (Nothing in Visual Basic) or System.String.Empty or white space  
    Public MethodBeOfTypeOverloaded. Asserts that the object is of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodBeOneOfOverloaded. Asserts that the System.String is one of the specified validValues.  
    Public MethodBeSameAs Asserts that an object reference refers to the exact same object as another object reference. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodBeUpperCasedAsserts that all cased characters in a string are upper-case. That is, that the string could be the result of a call to System.String.ToUpperInvariant.  
    Public MethodContainOverloaded.  Asserts that a string contains another (fragment of a) string.  
    Public MethodContainAllOverloaded. Asserts that a string contains all values present in values.  
    Public MethodContainAnyOverloaded. Asserts that a string contains at least one value present in values,.  
    Public MethodContainEquivalentOfOverloaded. Asserts that a string contains the specified expected, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodEndWithAsserts that a string ends exactly with the specified expected, including the casing and any leading or trailing whitespace.  
    Public MethodEndWithEquivalentOfOverloaded. Asserts that a string ends with the specified expected, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodEquals (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodHaveLengthAsserts that a string has the specified expected length.  
    Public MethodMatchOverloaded. Asserts that a string matches the wildcardPattern.  
    Public MethodMatchEquivalentOfOverloaded. Asserts that a string matches the wildcardPattern.  
    Public MethodMatchRegexOverloaded.  Asserts that a string matches a regular expression with expected occurrence  
    Public MethodNotBeAsserts that a string is not exactly the same as the specified unexpected, including the casing and any leading or trailing whitespace.  
    Public MethodNotBeAssignableToOverloaded. Asserts that the object is not assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodNotBeEmptyAsserts that a string is not System.String.Empty.  
    Public MethodNotBeEquivalentToOverloaded.  Asserts that a string is not exactly the same as another string, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodNotBeLowerCasedAsserts that of all the cased characters in a string, some are not lower-case. That is, the string could not be the result of a call to System.String.ToLowerInvariant.  
    Public MethodNotBeNull Asserts that the current object has been initialized. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodNotBeNullOrEmptyAsserts that a string is neither a null reference (Nothing in Visual Basic) nor System.String.Empty.  
    Public MethodNotBeNullOrWhiteSpaceAsserts that a string is neither a null reference (Nothing in Visual Basic) nor System.String.Empty nor white space  
    Public MethodNotBeOfTypeOverloaded. Asserts that the object is not of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodNotBeSameAs Asserts that an object reference refers to a different object than another object reference refers to. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodNotBeUpperCasedAsserts that of all the cased characters in a string, some are not upper-case. That is, the string could not be the result of a call to System.String.ToUpperInvariant.  
    Public MethodNotContain Asserts that a string does not contain another (fragment of a) string.  
    Public MethodNotContainAllOverloaded. Asserts that a string does not contain all of the strings provided in values. The string may contain some subset of the provided values.  
    Public MethodNotContainAnyOverloaded. Asserts that a string does not contain any of the strings provided in values.  
    Public MethodNotContainEquivalentOfOverloaded. Asserts that a string does not contain the specified unexpected string, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodNotEndWithAsserts that a string does not end exactly with the specified unexpected, including the casing and any leading or trailing whitespace.  
    Public MethodNotEndWithEquivalentOfOverloaded. Asserts that a string does not end with the specified unexpected, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodNotMatchAsserts that a string does not match the wildcardPattern.  
    Public MethodNotMatchEquivalentOfOverloaded. Asserts that a string does not match the wildcardPattern.  
    Public MethodNotMatchRegexOverloaded.  Asserts that a string does not match a regular expression.  
    Public MethodNotStartWithAsserts that a string does not start with the specified unexpected value, including the casing and any leading or trailing whitespace.  
    Public MethodNotStartWithEquivalentOfOverloaded. Asserts that a string does not start with the specified unexpected value, including any leading or trailing whitespace, with the exception of the casing.  
    Public MethodSatisfy<T>Allows combining one or more assertions using the other assertion methods that this library offers on an instance of T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<string,TAssertions>)
    Public MethodStartWithAsserts that a string starts exactly with the specified expected value, including the casing and any leading or trailing whitespace.  
    Public MethodStartWithEquivalentOfOverloaded. Asserts that a string starts with the specified expected, including any leading or trailing whitespace, with the exception of the casing.  
    Top
    Extension Methods
     NameDescription
    Public Extension MethodAs<TTo>Safely casts the specified object to the type specified through TTo.
    Public Extension MethodAwaitingOverloaded. Invokes the specified action on a subject so that you can chain it with any of the assertions from FluentAssertions.Specialized.NonGenericAsyncFunctionAssertions
    Public Extension MethodEnumeratingOverloaded. Forces enumerating a collection. Should be used to assert that a method that uses the yield keyword throws a particular exception.
    Public Extension MethodExecutionTimeOf<T> Provides methods for asserting the execution time of a method or property.
    Public Extension MethodInvokingOverloaded. Invokes the specified action on a subject so that you can chain it with any of the assertions from FluentAssertions.Specialized.ActionAssertions
    Public Extension MethodMonitorOverloaded. Starts monitoring eventSource for its events.
    Public Extension MethodShouldOverloaded. Returns an FluentAssertions.Specialized.ExecutionTimeAssertions object that can be used to assert the current FluentAssertions.Specialized.ExecutionTime.
    Public Extension MethodShouldOverloaded. Returns an FluentAssertions.Primitives.EnumAssertions<TEnum,TAssertions> object that can be used to assert the current TEnum.
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    StringAssertions<TAssertions> Members
    FluentAssertions.Primitives Namespace
    System.String

    Send Feedback