Class KeyCommentColumn
Provides a column that can syncronize the Comment metadata from the SharedTableData.SharedTableEntry.
Inherited Members
Namespace: UnityEditor.Localization.Plugins.Google.Columns
Syntax
[Serializable]
public class KeyCommentColumn : KeyMetadataColumn<Comment>Fields
ColumnHeader
Default column name "Key Comments".
Declaration
public const string ColumnHeader = "Key Comments"Field Value
| Type | Description |
|---|---|
| String |
Properties
PushFields
Controls which cell fields to synchronize.
Declaration
public override PushFields PushFields { get; }Property Value
| Type | Description |
|---|---|
| PushFields |
Overrides
Methods
PullMetadata(SharedTableData.SharedTableEntry, Comment, String, String)
Called during PullIntoStringTableCollection(Int32, StringTableCollection, IList<SheetColumn>, Boolean, ITaskReporter, Boolean) to extract data from a Google Spreadsheet column cell and convert it into IMetadata.
Declaration
public override void PullMetadata(SharedTableData.SharedTableEntry keyEntry, Comment metadata, string cellValue, string cellNote)Parameters
| Type | Name | Description |
|---|---|---|
| SharedTableData.SharedTableEntry | keyEntry | The entry for this column row. |
| Comment | metadata | |
| String | cellValue | The cell value from the Google Spreadsheet column. |
| String | cellNote | The cell note if one exists from the Google Spreadsheet column. |
Overrides
PushHeader(StringTableCollection, out String, out String)
Sets the column title and optional note. These values are always set regardless of the value of PushFields.
Declaration
public override void PushHeader(StringTableCollection collection, out string header, out string headerNote)Parameters
| Type | Name | Description |
|---|---|---|
| StringTableCollection | collection | |
| String | header | The title to use for the column header. |
| String | headerNote | Optional note that can be added to the header. |
Overrides
PushMetadata(Comment, out String, out String)
Called during PushStringTableCollection(Int32, StringTableCollection, IList<SheetColumn>, ITaskReporter) or PushStringTableCollectionAsync(Int32, StringTableCollection, IList<SheetColumn>, ITaskReporter). Used to extract values from IMetadata and convert them into a value and/or note that can be part of a Google Spreadsheet column cell.
Declaration
public override void PushMetadata(Comment metadata, out string value, out string note)Parameters
| Type | Name | Description |
|---|---|---|
| Comment | metadata | |
| String | value | The value that should appear in the Google Spreadsheet column cell. |
| String | note | The value that should appear in the Google Spreadsheet column as a note. Return null to not include a note. |