Class CustomPropertySchema

A custom property schema. This is the definition for properties on a type of element/object in the model (member/material/bolt/weld/etc). It's essentially a list of the types of properties available.

Inheritance

object

CustomPropertySchema

Implements

IEnumerable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: DesignData.SDS2.Setup

Assembly: DesignData.SDS2.Setup.dll

Syntax

public sealed class CustomPropertySchema : IEnumerable

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

Properties

Count

Get count of spacings

Declaration

public int Count { get; }

Property Value

Type	Description
int

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

this[int]

Get the nth spacing

Declaration

public CustomProperty this[int index] { get; }

Parameters

Type	Name	Description
int	index

Property Value

Type	Description
CustomProperty

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

Methods

Contains(string, CustomPropertyValueType, bool?, bool?, bool?, bool?)

Returns true if a matching property exists in this schema. You must give a name and a type to be checked, but all other properties (remarkable, hashable, erectionViewable, exported) are optional. If they're not specified then this will return a match regardless of those values on the property in the schema.

Declaration

public bool Contains(string name, CustomPropertyValueType type, bool? remarkable = null, bool? hashable = null, bool? erectionViewable = null, bool? exported = null)

Parameters

Type	Name	Description
string	name	The Name field of a CustomProperty
CustomPropertyValueType	type	The Type field of a CustomProperty.
bool?	remarkable	The IsRemarkable field of a CustomProperty. If unset or null is passed in, then we won't check this property. If set to true or false then true is only returned if a property has remarkable set to that value.
bool?	hashable	The IsHashable field of a CustomProperty. If unset or null is passed in, then we won't check this property. If set to true or false then true is only returned if a property has hashable set to that value.
bool?	erectionViewable	The IsErectionViewable field of a CustomProperty. If unset or null is passed in, then we won't check this property. If set to true or false then true is only returned if a property has erectionViewable set to that value.
bool?	exported	The IsExported field of a CustomProperty. If unset or null is passed in, then we won't check this property. If set to true or false then true is only returned if a property has exported set to that value.

Returns

Type	Description
bool

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

~CustomPropertySchema()

A custom property schema. This is the definition for properties on a type of element/object in the model (member/material/bolt/weld/etc). It's essentially a list of the types of properties available.

Declaration

protected ~CustomPropertySchema()

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

Get(CustomPropertyItemType)

Get a copy of the custom property schema for the given item type

Declaration

public static CustomPropertySchema Get(CustomPropertyItemType itemType)

Parameters

Type	Name	Description
CustomPropertyItemType	itemType	There are different schemas for members, materials, etc, specify which you want the schema for.

Returns

Type	Description
CustomPropertySchema

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

GetEnumerator()

Get the enumerator object

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
IEnumerator

Remarks

This schema is editable, but it will be a copy, so changes are not stored in the database when they're made on this object.

Implements

IEnumerable