iOS Designer でのカスタムコントロールの使用

[アーティクル]
05/02/2024

警告

iOS Designer は、Visual Studio 2019 バージョン 16.8 および Visual Studio 2019 for Mac バージョン 8.8 で非推奨とされ、Visual Studio 2019 バージョン 16.9 および Visual Studio for Mac バージョン 8.9 から削除されています。 iOS ユーザーインターフェイスを構築するために推奨される方法は、Xcode を実行している Mac 上で直接作業を行うことです。詳細については、「Xcode を使用したユーザーインターフェイスの設計」を参照してください。

要件

Xamarin Designer for iOS は、Visual Studio for Mac と Windows 上の Visual Studio 2017 以降で利用できます。

これらのガイドでは、「入門ガイド」で説明されている内容を理解していることが想定されています。

チュートリアル

重要

Xamarin.Studio 5.5 以降では、カスタムコントロールを作成する方法は、以前のバージョンとは若干異なります。カスタムコントロールを作成するには、IComponent インターフェイスが必要 (関連する実装メソッドを含む) か、クラスに [DesignTimeVisible(true)] の注釈を付けることができるかのいずれかです。次のチュートリアルの例では、後者の方法を使用しています。

[iOS] > [アプリ] > [単一ビューアプリケーション] > [C#] テンプレートから新しいソリューションを作成し、これに ScratchTicket の名前を付け、新しいプロジェクトウィザードを続行します。
ScratchTicketView という名前の新しい空のクラスファイルを作成します。

ScratchTicketView クラスに次のコードを追加します。

using System;
using System.ComponentModel;
using CoreGraphics;
using Foundation;
using UIKit;

namespace ScratchTicket
{
    [Register("ScratchTicketView"), DesignTimeVisible(true)]
    public class ScratchTicketView : UIView
    {
        CGPath path;
        CGPoint initialPoint;
        CGPoint latestPoint;
        bool startNewPath = false;
        UIImage image;

        [Export("Image"), Browsable(true)]
        public UIImage Image
        {
            get { return image; }
            set
            {
                image = value;
                SetNeedsDisplay();
            }
        }

        public ScratchTicketView(IntPtr p)
            : base(p)
        {
            Initialize();
        }

        public ScratchTicketView()
        {
            Initialize();
        }

        void Initialize()
        {
            initialPoint = CGPoint.Empty;
            latestPoint = CGPoint.Empty;
            BackgroundColor = UIColor.Clear;
            Opaque = false;
            path = new CGPath();
            SetNeedsDisplay();
        }

        public override void TouchesBegan(NSSet touches, UIEvent evt)
        {
            base.TouchesBegan(touches, evt);

            var touch = touches.AnyObject as UITouch;

            if (touch != null)
            {
                initialPoint = touch.LocationInView(this);
            }
        }

        public override void TouchesMoved(NSSet touches, UIEvent evt)
        {
            base.TouchesMoved(touches, evt);

            var touch = touches.AnyObject as UITouch;

            if (touch != null)
            {
                latestPoint = touch.LocationInView(this);
                SetNeedsDisplay();
            }
        }

        public override void TouchesEnded(NSSet touches, UIEvent evt)
        {
            base.TouchesEnded(touches, evt);
            startNewPath = true;
        }

        public override void Draw(CGRect rect)
        {
            base.Draw(rect);

            using (var g = UIGraphics.GetCurrentContext())
            {
                if (image != null)
                    g.SetFillColor((UIColor.FromPatternImage(image).CGColor));
                else
                    g.SetFillColor(UIColor.LightGray.CGColor);
                g.FillRect(rect);

                if (!initialPoint.IsEmpty)
                {
                    g.SetLineWidth(20);
                    g.SetBlendMode(CGBlendMode.Clear);
                    UIColor.Clear.SetColor();

                    if (path.IsEmpty || startNewPath)
                    {
                        path.AddLines(new CGPoint[] { initialPoint, latestPoint });
                        startNewPath = false;
                    }
                    else
                    {
                        path.AddLineToPoint(latestPoint);
                    }

                    g.SetLineCap(CGLineCap.Round);
                    g.AddPath(path);
                    g.DrawPath(CGPathDrawingMode.Stroke);
                }
            }
        }
    }
}

FillTexture.png、FillTexture2.png、Monkey.png ファイル (GitHub から入手可能) を [リソース] フォルダーに追加します。
Main.storyboard ファイルをダブルクリックして、デザイナーで開きます。
イメージビューをツールボックスからストーリーボードのビューにドラッグアンドドロップします。
[イメージビュー]を選択し、その [イメージ] プロパティを Monkey.png に変更します。
サイズクラスを使用しているため、このイメージビューを制約する必要があります。イメージを 2 回クリックして、制約モードにします。中心固定ハンドルをクリックして中心に制約し、垂直方向と水平方向の両方に揃えます。
高さと幅を制約するには、サイズ固定ハンドル ('骨' の形のハンドル) をクリックし、それぞれ幅と高さを選択します。
ツールバーの [更新] ボタンをクリックして、制約に基づいてフレームを更新します。
次に、[スクラッチチケットビュー] がツールボックスの [カスタムコンポーネント] の下に表示されるようにプロジェクトをビルドします。
サルのイメージを覆うように表示されるように、[スクラッチチケットビュー] をドラッグアンドドロップします。以下に示すように、スクラッチチケットビューがサルを完全に覆うようにドラッグハンドルを調整します。
両方のビューを選択するために外接する四角形を描画することで、スクラッチチケットビューをイメージビューに制約します。次に示すように、幅、高さ、中心、中央に制約するオプションを選択し、制約に基づいてフレームを更新します。
アプリケーションを実行し、画像を "スクラッチオフ" するとサルが現れます。

デザイン時のプロパティの追加

デザイナーには、プロパティ型の数値、列挙型、文字列、ブール値、CGSize、UIColor、UIImage などのカスタムコントロールのデザイン時のサポートも含まれています。デモを行うために、"スクラッチオフ" されたイメージを設定する ScratchTicketView にプロパティを追加してみましょう。

次のコードをプロパティの ScratchTicketView クラスに追加します。

[Export("Image"), Browsable(true)]
public UIImage Image
{
    get { return image; }
    set {
            image = value;
              SetNeedsDisplay ();
        }
}

次のように、Draw メソッドに null チェックを追加することもできます。

public override void Draw(CGRect rect)
{
    base.Draw(rect);

    using (var g = UIGraphics.GetCurrentContext())
    {
        if (image != null)
            g.SetFillColor ((UIColor.FromPatternImage (image).CGColor));
        else
            g.SetFillColor (UIColor.LightGray.CGColor);

        g.FillRect(rect);

        if (!initialPoint.IsEmpty)
        {
             g.SetLineWidth(20);
             g.SetBlendMode(CGBlendMode.Clear);
             UIColor.Clear.SetColor();

             if (path.IsEmpty || startNewPath)
             {
                 path.AddLines(new CGPoint[] { initialPoint, latestPoint });
                 startNewPath = false;
             }
             else
             {
                 path.AddLineToPoint(latestPoint);
             }

             g.SetLineCap(CGLineCap.Round);
             g.AddPath(path);
             g.DrawPath(CGPathDrawingMode.Stroke);
        }
    }
}

ExportAttribute と BrowsableAttribute を含み、引数を true に設定すると、プロパティはデザイナーの [プロパティ] パネルに表示されます。プロパティを FillTexture2.png などのプロジェクトに含まれる別のイメージに変更すると、以下に示すようにデザイン時にコントロールが更新されます。

まとめ

この記事では、カスタムコントロールを作成する方法と、iOS Designer を使用する iOS アプリケーションで使用する方法について説明しました。デザイナーの [ツールボックス] にあるアプリケーションで使用できるようにするために、コントロールを作成してビルドする方法を確認しました。さらに、デザイン時と実行時の両方で適切にレンダリングされるようにコントロールを実装する方法と、デザイナーでカスタムコントロールプロパティを公開する方法についても確認しました。

iOS Designer でのカスタム コントロールの使用

要件

チュートリアル

デザイン時のプロパティの追加

まとめ

関連リンク

その他のリソース

iOS Designer でのカスタムコントロールの使用