This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

SizeToString Method (String)

Returns a string that represents this instance (in fractional inches if advanced option XS_USE_ONLY_INCHES_IN_SHEET_SIZES set to true).

Namespace: Tekla.Structures.Drawing
Assembly: Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2023.0.1

Syntax

Copy

public string ToString(
	string separator
)

Public Function ToString ( 
	separator As String
) As String

Parameters

separator: Type: SystemString
The separator characters(s).

Return Value

Type: String
A string that represents this instance using the specified separator character(s).

Examples

This example shows how to convert a Size instance into a string representation using a specific separator parameter. The result is affected by the value of the advanced option: XS_USE_ONLY_INCHES_IN_SHEET_SIZES. In order for this advanced option to work, set the advanced options XS_IMPERIAL and XS_IMPERIAL_INPUT to TRUE. If the advanced option XS_USE_ONLY_INCHES_IN_SHEET_SIZES is set to TRUE the result would display as: 17" by 10"1/2 but if set to FALSE it would display as: 431.8 by 266.7

Copy

using Tekla.Structures.Drawing;

public class Example
{
       public void Example1()
       {
           // For this demonstration, we'll format 431.8x266.7 millimeters.
           Size size = new Size(431.8, 266.7);

           string formattedString = size.ToString(" by ");
       }
}

Reference

Size Class

ToString Overload

Tekla.Structures.Drawing Namespace

API Reference

SizeAddLanguageSpecificTextSet("LSTE8941283_0?cpp=::|nu=.");ToString Method (String)

Parameters

Return Value

Reference

SizeToString Method (String)