BH.oM.XML.Bluebeam.Markup¶
Class structure¶
Implemented interfaces and base types¶
The Markup is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.XML.Bluebeam.BluebeamObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
PageLabel | int | - | - |
Subject | string | - | - |
Space | string | - | - |
Author | string | - | - |
Date | string | - | - |
Colour | string | - | - |
Comments | string | - | - |
Length | double | - | - |
Area | double | - | - |
Label | string | - | - |
Depth | string | By default this is an XML String representation. Most software will automatically handle the conversion to a numerical representation but users can also use the Query.Depth(Markup) method if necessary. | - |
Layer | string | - | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
CustomData | Dictionary<string, object> | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
Depth | double | Returns the 'depth' property of a markup object as a double. If the value cannot be converted to a double (if the value is null or blank for example) then an error will be provided and 0 will be returned. | - | XML_Engine |
Code and Schema¶
C# implementation¶
C#
public class Markup : BH.oM.XML.Bluebeam.BluebeamObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
Assembly: XML_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/XML_oM/Bluebeam/Markup.json"
}
The JSON Schema is available on github here: