docs.unity3d.com
    Show / Hide Table of Contents

    Class KeyCommentColumn

    Provides a column that can syncronize the Comment metadata from the SharedTableData.SharedTableEntry.

    Inheritance
    Object
    SheetColumn
    KeyMetadataColumn<Comment>
    KeyCommentColumn
    Inherited Members
    KeyMetadataColumn<Comment>.PushBegin(StringTableCollection)
    KeyMetadataColumn<Comment>.PullBegin(StringTableCollection)
    KeyMetadataColumn<Comment>.PushCellData(SharedTableData.SharedTableEntry, IList<StringTableEntry>, String, String)
    KeyMetadataColumn<Comment>.PullCellData(SharedTableData.SharedTableEntry, String, String)
    SheetColumn.Column
    SheetColumn.ColumnIndex
    SheetColumn.PushEnd()
    SheetColumn.PullEnd()
    SheetColumn.IndexToColumnName(Int32)
    SheetColumn.ColumnNameToIndex(String)
    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
    SheetColumn.PushFields

    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
    UnityEditor.Localization.Plugins.Google.Columns.KeyMetadataColumn<UnityEngine.Localization.Metadata.Comment>.PullMetadata(UnityEngine.Localization.Tables.SharedTableData.SharedTableEntry, UnityEngine.Localization.Metadata.Comment, System.String, System.String)

    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
    SheetColumn.PushHeader(StringTableCollection, out String, out String)

    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.

    Overrides
    UnityEditor.Localization.Plugins.Google.Columns.KeyMetadataColumn<UnityEngine.Localization.Metadata.Comment>.PushMetadata(UnityEngine.Localization.Metadata.Comment, System.String, System.String)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Fields
      • ColumnHeader
    • Properties
      • PushFields
    • Methods
      • PullMetadata(SharedTableData.SharedTableEntry, Comment, String, String)
      • PushHeader(StringTableCollection, out String, out String)
      • PushMetadata(Comment, out String, out String)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023