IPCB_SpecialStringConverter interface
The IPCB_SpecialStringConverter interface provides a way to fetch special strings in a PCB Project. You would need to pass the document as a parameter in the Convert method and obtain the special strings.
public interface IPCB_SpecialStringConverter
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| AddForbiddenParamList | void | |
| Convert | bool | The convert method converts a special string as a formatted string and returns a boolean result whether the conversion is a success or not. |
| Convert_1 | bool | |
| FirstSpecialStringName | string | This method obtains the first special string name used in a design project (for example a PCB Project). |
| IsVCSRevisionSpecialString | bool | |
| NextSpecialStringName | string | This method obtains the next special string name used in a design project (for example a PCB Project). |
| RemoveForbiddenParamList | void |
AddForbiddenParamList
No description yet.
void AddForbiddenParamList(IPCB_ParameterList argData);
void AddForbiddenParamList(object argData);
| Parameter | Type | Passing |
|---|---|---|
argData | IPCB_ParameterList | value |
Returns: nothing (void)
The first overload is an extension method of IPCB_SpecialStringConverterHelper (using PCB;) with typed parameters; the second is declared by the interface.
Convert
The convert method converts a special string as a formatted string and returns a boolean result whether the conversion is a success or not.
bool Convert(IPCB_Primitive argPrimitive, string argString, out string argConvertedString);
bool Convert(object argPrimitive, string argString, out string argConvertedString);
| Parameter | Type | Passing |
|---|---|---|
argPrimitive | IPCB_Primitive | value |
argString | string | value |
argConvertedString | string | out |
Returns: bool
The first overload is an extension method of IPCB_SpecialStringConverterHelper (using PCB;) with typed parameters; the second is declared by the interface.
Convert_1
No description yet.
bool Convert_1(IPCB_Primitive argPrimitive, string argString, bool argWholeString, out string argConvertedString);
bool Convert_1(object argPrimitive, string argString, bool argWholeString, out string argConvertedString);
| Parameter | Type | Passing |
|---|---|---|
argPrimitive | IPCB_Primitive | value |
argString | string | value |
argWholeString | bool | value |
argConvertedString | string | out |
Returns: bool
The first overload is an extension method of IPCB_SpecialStringConverterHelper (using PCB;) with typed parameters; the second is declared by the interface.
FirstSpecialStringName
This method obtains the first special string name used in a design project (for example a PCB Project).
string FirstSpecialStringName();
Returns: string
See also: IPCB_SpecialStringConverter.NextSpecialStringName
IsVCSRevisionSpecialString
No description yet.
bool IsVCSRevisionSpecialString(string argString);
| Parameter | Type | Passing |
|---|---|---|
argString | string | value |
Returns: bool
NextSpecialStringName
This method obtains the next special string name used in a design project (for example a PCB Project).
string NextSpecialStringName();
Returns: string
RemoveForbiddenParamList
No description yet.
void RemoveForbiddenParamList();
Returns: nothing (void)