VSProject2.WorkOffline プロパティ

[アーティクル]
08/09/2011

Web プロジェクトがオンラインとオフラインのどちらで稼動しているかを示します。オフラインで稼動している場合は、サーバーにあるプロジェクトファイルが変更されないように、プロジェクトファイルのオフラインストアで開発を継続します。

名前空間: VSLangProj80
アセンブリ: VSLangProj80 (VSLangProj80.dll 内)

構文

'宣言
Property WorkOffline As Boolean
    Get
    Set

bool WorkOffline { get; set; }

property bool WorkOffline {
    bool get ();
    void set (bool value);
}

abstract WorkOffline : bool with get, set

function get WorkOffline () : boolean
function set WorkOffline (value : boolean)

プロパティ値

型: System.Boolean
ブール値。Web アプリケーションの場合、このプロパティは、オフライン作業時には true を返し、オンライン作業時には false を返します。ローカルプロジェクトの場合、このプロパティは false を返します。

実装

VSProject.WorkOffline

解説

プロジェクトがオフラインの場合、サーバーにあるプロジェクトのファイルへの書き込みまたはアクセスは行われません。

オフラインのプロジェクトファイルの URL を変更するには、Project.Properties コレクションの OfflineURL プロパティを使用します。

このプロパティを変更できるのは、Web プロジェクトの場合だけです。このプロパティは読み取り/書き込みプロパティですが、ローカルプロジェクトに対してこのプロパティを設定しようとするとエラーが発生します。

例

この例は、ソリューションの最初のプロジェクトが Visual Basic または Visual C# プロジェクトであるという前提です。このサンプルコードをアドインとして実行するには、「方法 : オートメーションオブジェクトモデルのコード例をコンパイルおよび実行する」を参照してください。

[Visual Basic]

' Add-in code.
Imports VSLangProj
Imports VSLangProj80
Public Sub OnConnection(ByVal application As Object,_
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    applicationObject = CType(application, DTE2)
    addInInstance = CType(addInInst, AddIn)
    WorkOfflineExample(applicationObject)
End Sub

Sub WorkOfflineExample(ByVal dte As DTE2)
    ' This example assumes that the first project in the solution is 
    ' a Visual Basic or C# project.
    Dim aVSProject As VSProject2 = _
    CType(applicationObject.Solution.Projects.Item(1).Object,_
    VSProject2)
    MsgBox("Work offline is: " & aVSProject.WorkOffline.ToString())
    Try
        MsgBox("Setting WorkOffline to false.")
        aVSProject.WorkOffline = False
    Catch e As System.Exception
        ' Setting the property fails for local projects.
        MsgBox(e.Message)
    End Try
    Try
        MsgBox("Setting WorkOffline to true.")
        aVSProject.WorkOffline = True
    Catch e As System.Exception
        ' Setting the property fails for local projects.
        MsgBox(e.Message)
    End Try
End Sub

[C#]

using System.Windows.Forms;
using VSLangProj;
using VSLangProj2;
using VSLangProj80;
public void OnConnection(object application, ext_ConnectMode
 connectMode, object addInInst, ref Array custom)
{ 
    applicationObject = (DTE2)application;
    addInInstance = (AddIn)addInInst;
    WorkOfflineExample((DTE2)applicationObject);
}

public void WorkOfflineExample( DTE2 dte ) 
{ 
// This example assumes that the first project in the solution is 
// a Visual Basic or C# project.
    VSProject2 aVSProject = ( ( VSProject2 )
(applicationObject.Solution.Projects.Item( 1 ).Object ) ); 
    MessageBox.Show( "Work offline is: " + 
aVSProject.WorkOffline.ToString()); 
    try 
    { 
        MessageBox.Show( "Setting WorkOffline to false."); 
        aVSProject.WorkOffline = false; 
    } 
    catch ( System.Exception e ) 
    { 
        // Setting the property fails for local projects.
        MessageBox.Show( e.Message); 
    } 
    try 
    { 
        MessageBox.Show( "Setting WorkOffline to true."); 
        aVSProject.WorkOffline = true; 
    } 
    catch ( System.Exception e ) 
    { 
        // Setting the property fails for local projects.
        MessageBox.Show( e.Message); 
    } 
}