BH.oM.PowerPoint.MultiLineTextUpdate¶
Allows to update the text content of a shape
Class structure¶
Implemented interfaces and base types¶
The MultiLineTextUpdate is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.PowerPoint.ISlideUpdate
- BH.oM.PowerPoint.IExcelModification
- BH.oM.PowerPoint.IPowerPointModification
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
SlideNumber | int | Number of the slide where the update needs to happen. | - |
ElementName | string | Name of the text element that needs to be updated. | - |
Text | List<string> | New text for the element. Each item in the list represents a new row. | - |
Colour | string | Colour of the text element that needs to be updated. | - |
UseLastParagraphProperties | bool | Whether to use the properties of the previous paragraph for subsequent paragraphs where there is no text to update. If set to false, new paragraphs will have default properties with no indentation. Default false. | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
CustomData | Dictionary<string, object> | - | - |
Code and Schema¶
C# implementation¶
C#
public class MultiLineTextUpdate : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.PowerPoint.ISlideUpdate,
BH.oM.PowerPoint.IExcelModification,
BH.oM.PowerPoint.IPowerPointModification
Assembly: PowerPoint_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/PowerPoint_oM/MultiLineTextUpdate.json"
}
The JSON Schema is available on github here: