Class CustomPropertyMap

A set of custom properties for a member, material, bolt, weld, or other item with custom properties.

Inheritance

object

CustomPropertyMap

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: DesignData.SDS2.Model

Assembly: DesignData.SDS2.Model.dll

Syntax

public class CustomPropertyMap

Methods

Dispose(bool)

A set of custom properties for a member, material, bolt, weld, or other item with custom properties.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~CustomPropertyMap()

A set of custom properties for a member, material, bolt, weld, or other item with custom properties.

Declaration

protected ~CustomPropertyMap()

Get(CustomPropertyMapHandle)

Get a CustomPropertyMap object for the handle passed in.

Declaration

public static CustomPropertyMap Get(CustomPropertyMapHandle handle)

Parameters

Type	Name	Description
CustomPropertyMapHandle	handle

Returns

Type	Description
CustomPropertyMap

Get(string, ref bool)

Get the value for the custom property name on this member

Declaration

public bool Get(string name, ref bool value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
bool	value

Returns

Type	Description
bool	true if the value is found and is of the correct type

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than double

Get(string, ref double)

Get the value for the custom property name on this member

Declaration

public bool Get(string name, ref double value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
double	value

Returns

Type	Description
bool	true if the value is found and is of the correct type

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than double

Get(string, ref DateTime?)

Get the value for the custom property name on this member

Declaration

public bool Get(string name, ref DateTime? value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
DateTime?	value

Returns

Type	Description
bool	true if the value is found and is of the correct type

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than DateTime

Get(string, ref string)

Lookup the value for the custom property name on this member

Declaration

public bool Get(string name, ref string value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
string	value

Returns

Type	Description
bool	true if the value is found and is of the correct type

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than string

GetPropertyType(string)

Get the type of a value. Which will be None if this does not exist

Declaration

public CustomPropertyValueType GetPropertyType(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
CustomPropertyValueType

Remarks

For Dimensions this returns Double to maintain compatibility, and reduce unnecessary code. To distinguish between doubles and dimensions look at Setup.CustomPropertySchema, that type will be dimension if it's a dimension.

Set(string, bool)

Set the value for the custom property name on this member

Declaration

public bool Set(string name, bool value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
bool	value

Returns

Type	Description
bool

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than bool
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Set(string, double)

Set the value for the custom property name on this member

Declaration

public bool Set(string name, double value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
double	value

Returns

Type	Description
bool

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than double
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Set(string, DateTime?)

Set the value for the custom property name on this member

Declaration

public bool Set(string name, DateTime? value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
DateTime?	value

Returns

Type	Description
bool

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than DateTime
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Set(string, string)

Set the value for the custom property name on this member

Declaration

public bool Set(string name, string value)

Parameters

Type	Name	Description
string	name	Set to the value if it's found, and true is returned.
string	value

Returns

Type	Description
bool

Exceptions

Type	Condition
CustomPropertyMissingException	If the custom property is not found in the schema
CustomPropertyTypeMismatchException	If the custom property is in the schema with a type other than string
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked