NetForumId Class

Represents an id (or key) on a NetFORUM entity in an unambiguous, comparable format.

Definition

Namespace: Ignition.Framework
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454

C#

public class NetForumId : IEquatable<NetForumId>, 
	IComparable<NetForumId>

VB

Public Class NetForumId
	Implements IEquatable(Of NetForumId), IComparable(Of NetForumId)

C++

public ref class NetForumId : IEquatable<NetForumId^>, 
	IComparable<NetForumId^>

F#

type NetForumId = 
    class
        interface IEquatable<NetForumId>
        interface IComparable<NetForumId>
    end

Inheritance: Object NetForumId

Implements: IComparableNetForumId, IEquatableNetForumId

Remarks

Use this type should always be preferred over String for representing NetFORUM keys, as NetFORUM's internal formatting of keys is inconsistent, which can lead to issues in comparing their values accurately.

Constructors

NetForumId(Guid)	Create a new NetForumId from a Guid key
NetForumId(String)	Create a new NetForumId from a string key

Methods

CompareTo
Equals(NetForumId)
Equals(Object)	(Overrides ObjectEquals(Object))
GetHashCode	(Overrides ObjectGetHashCode)
New	Initializes a new globally unique NetForumId, appropriate to use as the primary key for any given entity
ToSqlQuotedString	Returns a string version of the NetForumId, quoted for use in SQL queries
ToString	Converts the NetForumId to a string (Overrides ObjectToString)

Operators

Equality(NetForumId, NetForumId)	Equality operator
(NetForumId to Guid)	Converts a non-null NetForumId to a GUID
(NetForumId to NullableGuid)	Converts a NetForumId to a nullable GUID
(Guid to NetForumId)	Converts a GUID to a NetForumId
(NullableGuid to NetForumId)	Converts a nullable GUID to a NetForumId, or null
Inequality(NetForumId, NetForumId)	Inequality operator

Extension Methods

SafeToString	Converts a null reference or an instance of a NetForumId to a string. Null references will be converted to empty strings. (Defined by NetForumIdExtensions)
ToGuid	Converts an instance of a NetForumId to a Guid. Null references will result in an exception. (Defined by NetForumIdExtensions)
ToNullableGuid	Converts a null reference or an instance of a NetForumId to a Guid?. (Defined by NetForumIdExtensions)