ProSnippets Presentations - Esri/arcgis-pro-sdk GitHub Wiki

var projectPresentations = Project.Current.GetItems<PresentationProjectItem>();
foreach (var projectItem in projectPresentations)
{
  //Do Something with the presentation
}

//Reference a presentation associated with an active presentation view
PresentationView activePresentationView = PresentationView.Active;
if (activePresentationView != null)
{
  Presentation presentation = activePresentationView.Presentation;
}

PresentationProjectItem presentationProjItem = Project.Current.GetItems<PresentationProjectItem>().FirstOrDefault(item => item.Name.Equals(presentationName));
Presentation presentationFromItem = presentationProjItem?.GetPresentation();

//Open a presentation project item in a new view.
//A presentation project item may exist but it may not be open in a view. 

//Reference a presentation project item by name
PresentationProjectItem presentationPrjItem = Project.Current.GetItems<PresentationProjectItem>().FirstOrDefault(item => item.Name.Equals(presentationName));

//Get the presentation associated with the presentation project item
Presentation presentationToOpen = await QueuedTask.Run(() => presentationPrjItem.GetPresentation());

//Create the new pane
IPresentationPane iNewPresentationPane = await ProApp.Panes.CreatePresentationPaneAsync(presentationToOpen); //GUI thread

//Note: Call within QueuedTask.Run()
await QueuedTask.Run(() =>
{
  //Create a new presentation without parameters
  var presentation = PresentationFactory.Instance.CreatePresentation();
  // Use the new Presentation

  // Create a presentation specifying the name of the new presentation
  presentation = PresentationFactory.Instance.CreatePresentation("New Presentation");
  // Use the new Presentation
});

//Note: Call within QueuedTask.Run()
await QueuedTask.Run(() =>
{
  //Create mp4 format with appropriate settings
  MP4VideoFormat mp4Format = new MP4VideoFormat();
  mp4Format.Width = 800;
  mp4Format.Height = 600;
  mp4Format.OutputFileName = @"my folder\presentation.mp4";

  //Define Export Options
  PresentationExportOptions options = new PresentationExportOptions
  {
    PageRangeOption = ExportPageOptions.ExportByPageRange,
    CustomPages = "1,2,8"
  };

  //export as mp4
  presentation.Export(mp4Format, options);
});

//Assume we want to open a view for a particular presentation or activate a view if one is already open

//A presentation project item is an item that appears in the Presentation folder in the Catalog pane.
PresentationProjectItem presentationItem = Project.Current.GetItems<PresentationProjectItem>()
                                             .FirstOrDefault(item => item.Name.Equals(presentationName));

//Reference a presentation associated with a presentation project item
if (presentationItem != null)
{
  //Get the presentation associated with the presentationItem
  Presentation presentationToOpen = await QueuedTask.Run(() => presentationItem.GetPresentation());

  //Next check to see if a presentation view is already open that references the presentation
  foreach (var pane in ProApp.Panes)
  {
    var prePane = pane as IPresentationPane;
    if (prePane == null)  // Not a presentation view, continue to the next pane
      continue;

    //if there is a match, activate the view
    if (prePane.PresentationView.Presentation == presentationToOpen)
    {
      (prePane as Pane).Activate();
      return;
    }
  }

  //No pane found, activate a new one - must be called on UI
  IPresentationPane iNewPresentationPane = await ProApp.Panes.CreatePresentationPaneAsync(presentationToOpen); //GUI thread
}

//Note: Call within QueuedTask.Run()
Presentation presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  // add a blank page with with title and paragraph body text element
  presentation.AddBlankPage(BlankPageTemplateType.TitleAndParagraph, -1);
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  // add a new image page in current active presentation
  var imagePage = presentation.AddImagePage("my image source", -1);

  // change the image source
  imagePage.SetImageSource("new image source");
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  // add a new video page in current active presentation
  var videoPage = presentation.AddVideoPage("my video file", -1);

  // change the image source
  videoPage.SetVideoSource("new video source");

  // change the start time of video to 3s
  videoPage.SetStartTime(3.0);
  // change the end time of video to 10s
  videoPage.SetEndTime(10.0);
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  // retrieve a map from the project based on the map name
  MapProjectItem mpi = Project.Current.GetItems<MapProjectItem>()
                             .FirstOrDefault(m => m.Name.Equals("Your Map Name", StringComparison.CurrentCultureIgnoreCase));
  Map map = mpi.GetMap();
  //create a map page using map's default extent
  presentation.AddMapPage(map, -1);

  //create a page using map's bookmark
  Bookmark bookmark = map.GetBookmarks().FirstOrDefault(
               b => b.Name == "Your bookmark"); // get the bookmark based on the bookmark's name
  presentation.AddMapPage(bookmark, -1);
});

//Must be on the QueuedTask
await QueuedTask.Run(() =>
{
  //Reference a map page
  var mpage = activePresentationView.Presentation.GetPage(4) as MapPresentationPage;

  //Set the map frame extent based on the new camera's X,Y, Scale and heading values
  Camera cam = new Camera(329997.6648, 6248553.1457, 2403605.8968, 24);
  mpage.SetCamera(cam);
});

//Must be on the QueuedTask
await QueuedTask.Run(() =>
{
  //Reference map page
  var mpage = activePresentationView.Presentation.GetPage(4) as MapPresentationPage;

  //Reference map and layer
  MapProjectItem mp = Project.Current.FindItem("Page name") as MapProjectItem;
  Map map = mp.GetMap();
  FeatureLayer lyr = map.FindLayers("GreatLakes").First() as FeatureLayer;

  //Set the map frame extent to all features in the layer
  mpage.SetCamera(lyr);
});

// Note: we are on the UI thread!
// A presentation view must be active
if (PresentationView.Active == null)
  return;
PresentationPage activePage = activePresentationView.ActivePage;

//check if the current page is a map page
if (activePage is MapPresentationPage)
{
  await activePresentationView.ActivateMapPageAsync();
}

//move to the QueuedTask to do something
await QueuedTask.Run(() =>
{
  // TODO
});

// create customized margin and color 
CIMMargin pMargin = new CIMMargin() { Left = 0.2, Right = 0.3, Top = 0.15, Bottom = 0.25 };
CIMRGBColor pColor = new CIMRGBColor() { R = 255, G = 255, B = 0, Alpha = 50 };

//Reference a page and its transition 
var page = activePresentationView.Presentation.GetPage(0);
CIMPresentationTransition transition = page.Transition;

// update the transition style
transition.TransitionType = PresentationTransitionType.Swipe;
transition.Duration = 2.0;
transition.SwipeDirection = SwipeDirection.Top;

//Must be on the QueuedTask
await QueuedTask.Run(() =>
{
  //Set the new margin, new background color and new transition effect
  page.SetMargin(pMargin);
  page.SetBackgroundColor(pColor);
  page.SetTransition(transition);
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  //create a picture element
  var imgPath = @"https://www.esri.com/content/dam/esrisites/en-us/home/" +
   "homepage-tile-podcast-business-resilience-climate-change.jpg";

  //Build a geometry to place the picture
  Coordinate2D ll = new Coordinate2D(3.5, 1);
  Coordinate2D ur = new Coordinate2D(6, 5);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);
  //create a picture element on the page
  var gElement = PresentationElementFactory.Instance.CreatePictureGraphicElement(page, env, imgPath);

  //create a text element
  //Set symbology, create and add element to a presentation page
  CIMTextSymbol sym = SymbolFactory.Instance.ConstructTextSymbol(
                ColorFactory.Instance.RedRGB, 15, "Arial", "Regular");
  //use ElementInfo to set placement properties
  var elemInfo = new ElementInfo()
  {
    Anchor = Anchor.CenterPoint,
    Rotation = 45
  };
  string textString = "My text";
  var textPos = new Coordinate2D(5, 3).ToMapPoint();
  var tElement = PresentationElementFactory.Instance.CreateTextGraphicElement(page,
    TextType.PointText, textPos, sym, textString, "telement", false, elemInfo);

  //create a group element with elements created above
  var elmList = new List<Element> { gElement, tElement };
  GroupElement grp1 = PresentationElementFactory.Instance.CreateGroupElement(page, elmList, "My Group");
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  // Find specific elements by name
  var ge_rect = page.FindElement("Rectangle") as GraphicElement;
  var elements = new List<string>();
  elements.Add("Text");
  elements.Add("Polygon");
  var elems = page.FindElements(elements);

  //Get elements retaining hierarchy
  var top_level_elems = page.GetElements();

  //Flatten hierarchy
  var all_elems = page.GetFlattenedElements();

  //Use LINQ with any of the collections
  //Retrieve just those elements that are Visible
  var some_elems = all_elems.Where(ge => ge.IsVisible).ToList();
});

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  //Select/unselect some elements...
  var elems = activePage.GetFlattenedElements();
  //select any element not a group element
  activePage.SelectElements(elems.Where(e => !e.Name.StartsWith("Group")));
  activePage.UnSelectElements(elems.Where(e => !e.Name.StartsWith("Group")));

  //Select/unselect all visible, graphic elements
  var ge_elems = elems.Where(ge => ge.IsVisible).ToList();
  activePage.SelectElements(ge_elems);
  activePage.UnSelectElements(ge_elems);

  //Select/unselect a specific element
  var na = activePage.FindElement("My Text Element");
  activePage.SelectElement(na);
  activePage.UnSelectElement(na);

  //Select everything
  activePage.SelectElements(elems);

  //enumerate the selected elements
  foreach (var sel_elem in activePage.GetSelectedElements())
  {
    //TODO
  }
});

ArcGIS.Desktop.Presentations.Events.PresentationEvent.Subscribe((args) =>
{
  var presentation = args.Presentation; //The presentation that was changed

  //Check what triggered the event and take appropriate action
  switch (args.Hint)
  {
    case PresentationEventHint.PropertyChanged:
      //TODO handle presentation property changed
      break;
    case PresentationEventHint.PageAdded:
      //TODO handle a new page added
      break;
    case PresentationEventHint.PageRemoved:
      //TODO handle a page removed from the presentation
      break;
    case PresentationEventHint.PageSettingChanged:
      //TODO handle page settings changed
      break;
  }
});

//For UI context changes associated with a presentation, subscribe to the PresentationView
//event - views activated/deactivated, views opened/closed
ArcGIS.Desktop.Presentations.Events.PresentationViewEvent.Subscribe((args) =>
{
  //get the affected view and presentation
  var view = args.PresentationView;
  var presentation = args.PresentationView?.Presentation;
  if (presentation == null)
  {
    //FYI presentationview and/or presentation can be null...
    //eg closed, deactivation
  }
  //Check what triggered the event and take appropriate action
  switch (args.Hint)
  {
    case PresentationViewEventHint.Activated:
      // Presentation view activated
      break;
    case PresentationViewEventHint.Opened:
      //A PresentationView has been initialized and opened
      break;
    case PresentationViewEventHint.Deactivated:
      // Presentation view deactivated
      break;
    case PresentationViewEventHint.Closing:
      //Set args.Cancel = true to prevent closing
      break;
    case PresentationViewEventHint.ExtentChanged:
      //presentation view extent has changed
      break;
    case PresentationViewEventHint.DrawingComplete:
      break;
    case PresentationViewEventHint.PauseDrawingChanged:
      break;
  }
});