Skip to content

BH.oM.Base.Attributes.FilePathAttribute

Path to a file in the client's file system.

Class structure

Implemented interfaces and base types

The FilePathAttribute is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
FileExtensions string[] Collection of file extensions allowed for a member this attribute corresponds to. Any extension is allowed if null or empty. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
Name string Name of the method parameter this attribute corresponds to (not relevant in case of object properties). -
TypeId object - -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
Description string Return the description of a file path attribute. - Reflection_Engine
IDescription string Return the custom description of a classification attribute. - Reflection_Engine

Code and Schema

C# implementation

C#
public class FilePathAttribute : BH.oM.Base.Attributes.ClassificationAttribute, System.Attribute, BH.oM.Base.IImmutable, BH.oM.Base.IObject

Assembly: BHoM.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/BHoM/Attributes/FilePathAttribute.json"
}

The JSON Schema is available on github here: