# ISch_SheetSymbol interface

Sheet symbols represent other schematic sheets (often referred to as a child sheet). The link between a sheet symbol and other schematic sheets is the FileName attribute, which must be the same as the name of the child sheet.

```csharp
public interface ISch_SheetSymbol : ISch_RectangularGroup
```

**Namespace:** SCH · **Assembly:** Altium.SDK.Interfaces

**Inherits:** [ISch_BasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md) → [ISch_GraphicalObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md) → [ISch_ParametrizedGroup](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ParametrizedGroup.md) → [ISch_RectangularGroup](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_RectangularGroup.md)

**Derived:** [ISch_HighLevelCodeSymbol](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_HighLevelCodeSymbol.md)

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [DesignItemId](#designitemid) | `string` | get; set |  |
| [IsSolid](#issolid) | `bool` | get; set | The `IsSolid` property denotes whether the sheet symbol object has a solid fill or not. |
| [ItemGUID](#itemguid) | `string` | get; set |  |
| [LibIdentifierKind](#libidentifierkind) | [TLibIdentifierKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/TLibIdentifierKind.md) | get |  |
| [LibraryIdentifier](#libraryidentifier) | `string` | get |  |
| [LineWidth](#linewidth) | [TSize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSize.md) | get; set | The `LineWidth` property defines the border width of the sheet symbol with one of the following values from the [`TSize`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSize.md) enumerated type. |
| [RevisionGUID](#revisionguid) | `string` | get; set |  |
| [SchSheetFileName](#schsheetfilename) | [ISch_SheetFileName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetFileName.md) | get | The `SchSheetFileName` property denotes the FileName text object which is represented by the [`ISch_SheetFileName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetFileName.md) interface object associated with the sheet symbol. |
| [SchSheetName](#schsheetname) | [ISch_SheetName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetName.md) | get | The `SchSheetName` property denotes the Designator Name text object which is represented by the [`ISch_SheetName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetName.md) interface object associated with the sheet symbol. |
| [ShowHiddenFields](#showhiddenfields) | `bool` | get; set | The `ShowHiddenFields` property determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. |
| [SourceLibraryName](#sourcelibraryname) | `string` | get; set |  |
| [SymbolType](#symboltype) | [TSheetSymbolType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSheetSymbolType.md) | get; set |  |
| [VaultGUID](#vaultguid) | `string` | get; set |  |

### DesignItemId

*No description yet.*

```csharp
string GetState_DesignItemId();
void SetState_DesignItemId(string argValue);
```

**Type:** `string` · **Access:** read/write

### IsSolid

The `IsSolid` property denotes whether the sheet symbol object has a solid fill or not.

```csharp
bool GetState_IsSolid();
void SetState_IsSolid(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### ItemGUID

*No description yet.*

```csharp
string GetState_ItemGUID();
void SetState_ItemGUID(string argValue);
```

**Type:** `string` · **Access:** read/write

### LibIdentifierKind

*No description yet.*

```csharp
TLibIdentifierKind GetState_LibIdentifierKind();
```

**Type:** [TLibIdentifierKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/TLibIdentifierKind.md) · **Access:** read-only

The accessors are extension methods of `ISch_SheetSymbolHelper` (`using SCH;`).

### LibraryIdentifier

*No description yet.*

```csharp
string GetState_LibraryIdentifier();
```

**Type:** `string` · **Access:** read-only

### LineWidth

The `LineWidth` property defines the border width of the sheet symbol with one of the following values from the [`TSize`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSize.md) enumerated type.

```csharp
TSize GetState_LineWidth();
void SetState_LineWidth(TSize argValue);
```

**Type:** [TSize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSize.md) · **Access:** read/write

The accessors are extension methods of `ISch_SheetSymbolHelper` (`using SCH;`).

**See also:** [TSize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSize.md)

### RevisionGUID

*No description yet.*

```csharp
string GetState_RevisionGUID();
void SetState_RevisionGUID(string argValue);
```

**Type:** `string` · **Access:** read/write

### SchSheetFileName

The `SchSheetFileName` property denotes the FileName text object which is represented by the [`ISch_SheetFileName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetFileName.md) interface object associated with the sheet symbol. The [`ISch_SheetFileName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetFileName.md) interface is inherited from the [`ISch_ComplexText`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ComplexText.md) and [`ISch_Label`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Label.md) interfaces.

```csharp
ISch_SheetFileName GetState_SchSheetFileName();
```

**Type:** [ISch_SheetFileName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetFileName.md) · **Access:** read-only

The accessors are extension methods of `ISch_SheetSymbolHelper` (`using SCH;`).

**Example:** Show the file name of every sheet symbol on the current schematic sheet.

```csharp
using SCH;

ISch_Document currentSheet = SCH.GlobalVars.SchServer?.GetCurrentSchDocument();
if (currentSheet == null)
    return;
ISch_Iterator iterator = currentSheet.SchIterator_Create();
iterator.AddFilter_ObjectSet(new SCH.TObjectSet { TObjectId.eSheetSymbol });
try
{
    for (var sSheet = iterator.FirstSchObject() as ISch_SheetSymbol; sSheet != null; sSheet = iterator.NextSchObject() as ISch_SheetSymbol)
    {
        ISch_SheetFileName sheetFileName = sSheet.GetState_SchSheetFileName();
        if (sheetFileName != null)
            DXP.Utils.ShowMessage(sheetFileName.GetState_Text());
    }
}
finally
{
    currentSheet.SchIterator_Destroy(ref iterator);
}
```

### SchSheetName

The `SchSheetName` property denotes the Designator Name text object which is represented by the [`ISch_SheetName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetName.md) interface object associated with the sheet symbol. The [`ISch_SheetName`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetName.md) interface is inherited from the [`ISch_ComplexText`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ComplexText.md) and [`ISch_Label`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Label.md) interfaces.

```csharp
ISch_SheetName GetState_SchSheetName();
```

**Type:** [ISch_SheetName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetName.md) · **Access:** read-only

The accessors are extension methods of `ISch_SheetSymbolHelper` (`using SCH;`).

**Example:** Show the sheet name of every sheet symbol on the current schematic sheet.

```csharp
using SCH;

ISch_Document currentSheet = SCH.GlobalVars.SchServer?.GetCurrentSchDocument();
if (currentSheet == null)
    return;
ISch_Iterator iterator = currentSheet.SchIterator_Create();
iterator.AddFilter_ObjectSet(new SCH.TObjectSet { TObjectId.eSheetSymbol });
try
{
    for (var sSheet = iterator.FirstSchObject() as ISch_SheetSymbol; sSheet != null; sSheet = iterator.NextSchObject() as ISch_SheetSymbol)
    {
        ISch_SheetName sheetName = sSheet.GetState_SchSheetName();
        if (sheetName != null)
            DXP.Utils.ShowMessage(sheetName.GetState_Text());
    }
}
finally
{
    currentSheet.SchIterator_Destroy(ref iterator);
}
```

### ShowHiddenFields

The `ShowHiddenFields` property determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. If the Value is true, the hidden fields of the sheet symbol will be displayed on the schematic sheet. If the value is false, the hidden text fields are not shown on the schematic.

```csharp
bool GetState_ShowHiddenFields();
void SetState_ShowHiddenFields(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### SourceLibraryName

*No description yet.*

```csharp
string GetState_SourceLibraryName();
void SetState_SourceLibraryName(string argValue);
```

**Type:** `string` · **Access:** read/write

### SymbolType

*No description yet.*

```csharp
TSheetSymbolType GetState_SymbolType();
void SetState_SymbolType(TSheetSymbolType argValue);
```

**Type:** [TSheetSymbolType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSheetSymbolType.md) · **Access:** read/write

The accessors are extension methods of `ISch_SheetSymbolHelper` (`using SCH;`).

### VaultGUID

*No description yet.*

```csharp
string GetState_VaultGUID();
void SetState_VaultGUID(string argValue);
```

**Type:** `string` · **Access:** read/write

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [ChangeSymbolType](#changesymboltype) | `void` |  |

### ChangeSymbolType

*No description yet.*

```csharp
void ChangeSymbolType(TSheetSymbolType argType);
void ChangeSymbolType(int argType);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argType` | [TSheetSymbolType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSheetSymbolType.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `ISch_SheetSymbolHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

## Inherited members

- From [ISch_RectangularGroup](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_RectangularGroup.md): [XSize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_RectangularGroup.md#xsize), [YSize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_RectangularGroup.md#ysize)
- From [ISch_ParametrizedGroup](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ParametrizedGroup.md): [Import_FromUser_Parameters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ParametrizedGroup.md#import_fromuser_parameters), [ResetAllSchParametersPosition](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ParametrizedGroup.md#resetallschparametersposition)
- From [ISch_GraphicalObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md): [AddErrorString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#adderrorstring), [AreaColor](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#areacolor), [BoundingRectangle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#boundingrectangle), [BoundingRectangle_Full](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#boundingrectangle_full), [Color](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#color), [CompilationMasked](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#compilationmasked), [Dimmed](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#dimmed), [Disabled](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#disabled), [DisplayError](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#displayerror), [EnableDraw](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#enabledraw), [ErrorColor](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorcolor), [ErrorKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorkind), [ErrorString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorstring), [GetHash](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#gethash), [GraphicallyInvalidate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#graphicallyinvalidate), [LiveHighlightValue](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#livehighlightvalue), [Location](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#location), [Mirror](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#mirror), [MoveByXY](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#movebyxy), [MoveToXY](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#movetoxy), [OwnerPartDisplayMode](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#ownerpartdisplaymode), [OwnerPartId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#ownerpartid), [ResetErrorFields](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#reseterrorfields), [RotateBy90](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#rotateby90), [Selection](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#selection), [SetState_xSizeySize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#setstate_xsizeysize)
- From [ISch_BasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md): [AddAndPositionSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#addandpositionschobject), [AddSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#addschobject), [CopyTo](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#copyto), [DeleteAll](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#deleteall), [DescriptionString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#descriptionstring), [ExportToParameters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#exporttoparameters), [FreeAllContainedObjects](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#freeallcontainedobjects), [Handle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#handle), [IdentifierString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#identifierstring), [Import_FromUser](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#import_fromuser), [ObjectId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#objectid), [OwnerSchDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#ownerschdocument), [RemoveSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#removeschobject), [Replicate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#replicate), [SchBasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schbasiccontainer), [SchIterator_Create](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schiterator_create), [SchIterator_Destroy](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schiterator_destroy), [SchParameterByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schparameterbyname), [Setstate_Default](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#setstate_default), [Text](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#text), [UniqueId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#uniqueid), [WiringDiagramOriginUniqueId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#wiringdiagramoriginuniqueid)

## Returned by

[ISch_ServerInterface.LoadDesignItemDeviceSheet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_ServerInterface.md#loaddesignitemdevicesheet), [ISch_SheetEntry.OwnerSchSheetSymbol](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetEntry.md#ownerschsheetsymbol)